POST
/v2/apps/{app_id}/job-invocations/{job_invocation_id}/cancelCancel a job invocation
Cancels a job invocation for a specified app. Use app_id and job_invocation_id to identify the invocation, and provide job_name to identify the associated job when needed. The response includes the invocation's phase and lifecycle timestamps.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
app_idstringrequired
The unique identifier of the app containing the job invocation.
job_invocation_idstringrequired
The unique identifier of the job invocation to cancel.
job_namestringoptional
The name of the job associated with the invocation.
200Returns the job invocation object, including its ID, job name, deployment ID, phase, trigger details, and creation, start, and completion timestamps.
idstringoptional
job_namestringoptional
deployment_idstringoptional
phasestringoptional
The phase of the job invocation
triggerobjectoptional
created_atstringoptional
started_atstringoptional
completed_atstringoptional
401Returned when authentication fails because the credentials are invalid.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
404Returned when the requested resource is not found.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
429Returned when the API rate limit has been exceeded.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
500Returned when a server error occurs.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
defaultThere was an unexpected error.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
Error handling
A 401 is returned when credentials are invalid; a 404 is returned when the app or job invocation is not found; a 429 is returned when the API rate limit is exceeded; and a 500 is returned for a server error. The app_id path parameter and job_invocation_id path parameter identify the invocation; the job_name query parameter identifies the job when provided.