Cancel Job | Captain Docs

Cancel/delete an indexing job.

Maps to POST /v1/index-stop/{job_id}

Behavior:

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

Returns:

job_id: The job identifier
status: Current status after cancel attempt
message: Human-readable description
cancelled_at: Cancellation timestamp (RFC3339)

Authentication: Requires Bearer token in Authorization header

Cancel/delete an indexing job. Maps to POST /v1/index-stop/{job_id} Behavior: - If job is pending or running -> transition to cancelled - If job is already completed/failed/cancelled -> return 200 with current state (idempotent) Returns: - job_id: The job identifier - status: Current status after cancel attempt - message: Human-readable description - cancelled_at: Cancellation timestamp (RFC3339) Authentication: Requires Bearer token in Authorization header

Path parameters

job_idstringRequired

Response

Successful Response

job_idstring

messagestring

statusstring

cancelled_atstring

cleanup_initiatedboolean

1	import requests
2
3	url = "https://host.com/v2/jobs/job_id"
4
5	response = requests.delete(url)
6
7	print(response.json())

1	{
2	"job_id": "job_id",
3	"message": "message",
4	"status": "status",
5	"cancelled_at": "cancelled_at",
6	"cleanup_initiated": true
7	}

Path parameters

Headers

Response