Cancel Job | Captain Docs

Cancel an indexing job.

Behavior:

If job is pending or running -> transitions to cancelled
If job is already completed/failed/cancelled -> returns 200 with current state (idempotent)

Cancel an indexing job. Behavior: - If job is pending or running -> transitions to cancelled - If job is already completed/failed/cancelled -> returns 200 with current state (idempotent)

Path parameters

job_idstringRequired

The job ID to cancel

Response

Cancel Result

job_idstring

statusstring

messagestring

cancelled_atstring or null

1	import requests
2
3	BASE_URL = "https://api.runcaptain.com"
4	API_KEY = "your_api_key"
5	job_id = "your_job_id"
6
7	headers = {
8	"Authorization": f"Bearer {API_KEY}"
9	}
10
11	response = requests.post(
12	f"{BASE_URL}/v2/jobs/{job_id}/cancel",
13	headers=headers,
14	timeout=30.0
15	)
16
17	if response.status_code == 200:
18	result = response.json()
19	print(f"Job status: {result.get('status')}")
20	print(f"Message: {result.get('message')}")
21	else:
22	print(f"Error: {response.status_code}")

1	{
2	"job_id": "abc123xyz-1234567890",
3	"status": "cancelled",
4	"message": "Job cancelled successfully",
5	"cancelled_at": "2024-01-15T10:30:45Z"
6	}

Path parameters

Headers

Response