GET/v2/apps/{app_id}/job-invocations/{job_invocation_id}

Retrieve a job invocation

Retrieves a specific job invocation for an app. Use job_invocation_id to select the invocation and optionally provide job_name to specify the job associated with it.

3 parameters
app_idstringrequired
The unique identifier of the app that owns the job invocation.
job_invocation_idstringrequired
The unique identifier of the job invocation to retrieve.
job_namestringoptional
The name of the job associated with the invocation.

6 status codes
200Returns the job invocation object, including its job name, deployment identifier, phase, trigger, and lifecycle timestamps.
idstringoptional
job_namestringoptional
deployment_idstringoptional
phasestringoptional
The phase of the job invocation
Allowed:UNKNOWNPENDINGRUNNINGSUCCEEDEDFAILEDCANCELEDSKIPPED
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 authentication credentials are invalid. A 404 is returned when the requested resource is not found, a 429 when the API rate limit is exceeded, and a 500 when a server error occurs. The app_id and job_invocation_id path parameters must identify the app and invocation to retrieve.