Request job cancellation
Cancellation is cooperative; poll the returned job until it reaches a terminal status. Already-dispatched external actions cannot be undone.
/v1/jobs/{id}/cancelPath parameters
idstringrequiredMin length: 1
Response
200Request job cancellation
X-Request-IdstringServer-generated request identifier for logs and support.
application/json
idstringrequiredMin length: 1
user_idstringrequiredMin length: 1
application_idstringMin length: 1
sequenceintegerrequiredMinimum: -9007199254740991 · Maximum: 9007199254740991
taskstringrequiredstatusstringrequiredAllowed: "queued""provisioning""running""waiting_approval""completed""failed""cancelled""timed_out"
execution_modestringrequiredAllowed: "computer""tools"
created_atstringrequiredFormat: date-time · Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
started_atstring | nullrequiredcompleted_atstring | nullrequiredcomputer_idstring | nullrequiredinstructionsstring | nullreasoning_effortstring | nullmax_output_tokensinteger | nullerrorstring | nullrequiredfailure_classstring | nullcomputer_ready_atstring | nullcomputer_startstring | nullfirst_output_atstring | nullresult_jsonobject | nullrequiredevaluationobjectrequiredAdditional keys: any
viewer_urlstringrequiredFormat: uri
is_controllerbooleanrequiredflow_idstring | nullflow_snapshot_jsonobject | nullharness_version_idstring | nullharness_jsonobject | nullAllowed shapes
object
harness_idstringrequiredMin length: 1
namestringrequiredversion_idstringrequiredMin length: 1
numberintegerrequiredMinimum: -9007199254740991 · Maximum: 9007199254740991
specobjectrequiredAdditional keys: any
null
valuenullcost_nanoobjectObject fields
model_usagenumberrequiredcomputer_timenumberrequiredkept_computernumberrequiredtotalnumberrequiredAdditional keys: any
4XX400 invalid input; 401 missing/revoked credentials; 403 disallowed operation/application; 404 missing or inaccessible resource; 409 conflicting submission/version/state; 413 body too large; 415 unsupported content type. Inspect error.code, not message text.
X-Request-IdstringServer-generated request identifier for logs and support.
application/json
errorobjectrequiredObject fields
codestringrequiredmessagestringrequiredrequest_idstringrequiredAdditional keys: any
5XX500 unexpected failure or 503 unavailable dependency. A failed response does not prove that a submission was not committed. Retry job/flow admission with the same key and body.
X-Request-IdstringServer-generated request identifier for logs and support.
application/json
errorobjectrequiredObject fields
codestringrequiredmessagestringrequiredrequest_idstringrequiredAdditional keys: any