Cancel a run
Cancels a run and its job. Only the credential that started the run can cancel it. A cancel runs no compensation: the log lists the writes that are done. Needs the scope machines.
Authentication
AuthorizationBearer
An API key (crk_), an exchanged token (crt_) or a JWT of a trusted issuer. The credential needs the scope of the capability. Read the description of each route.
Path parameters
id
The run id. It is also the job id: job_ and a ULID.
Response headers
x-request-id
The id of the request: req_ and a ULID. Every answer has it.
server-timing
The time of the admission.
x-ratelimit-limit-requests
The size of the request bucket, per minute.
x-ratelimit-remaining-requests
The requests that remain.
x-ratelimit-reset-requests
The time until the request bucket is full.
x-ratelimit-limit-units
The size of the units bucket, per minute. Absent when no limit applies.
x-ratelimit-remaining-units
The units that remain.
x-ratelimit-reset-units
The time until the units bucket is full.
Response
The cancelled job.
object
id
job_ and a ULID.
capability
The capability of the job.
status
The status of the job.
deadline
Only asap at this time.
created_at
When the API accepted the job.
completed_at
When the job ended. Null while the job runs.
output
The output of a succeeded job, or null. The shape depends on the capability. The stored output is at most 1048576 bytes.
error
Why a job did not succeed.
usage
The metered use of a job.
run_id
The Run run id. Agent jobs only.
required_action
Machine jobs only. What the job waits for while its status is needs_input, else null. The other jobs do not have this field.
Errors
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error