Skip to content

Cancel job (system admin only)

POST
/jobs/{jobId}/cancel

Cancel a pending or claimed job. Jobs that are already running, succeeded, failed, or cancelled cannot be cancelled. Requires system admin access.

jobId
required
string

Job cancelled successfully

object
id
required
string
taskType
required
string
payload
nullable
result
nullable
status
required
string
Allowed values: pending claimed running succeeded failed cancelled
affinityTags
required
Array<string>
workerId
required
string
nullable
leaseExpiresAt
required
string format: date-time
nullable
heartbeatAt
required
string format: date-time
nullable
attempt
required
number
maxAttempts
required
number
errorMessage
required
string
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
completedAt
required
string format: date-time
nullable

Bad request - job cannot be cancelled

object
error
required
string
code
string

Forbidden - system admin access required

object
error
required
string
code
string

Job not found

object
error
required
string
code
string