Sign in

v2

latestOpenAPI 3.1.02026-08-06276982.8 KB
runs

Get run status

Get the status of a run.

get/v2/apps/runs/{run_id}

Path parameters

run_idstring required

The run ID.

Headers

Authorizationstring required

Bearer HTTP authentication.

IB-Contextstring

Typically your organization ID. See Authorization and context identification for details.

Response

Successful response.

idstring

Run ID of the run.

status'CANCELLED' | 'COMPLETE' | 'FAILED' | 'PAUSED' | 'RUNNING' | 'STOPPED_AT_CHECKPOINT'

Status of the run. Possible values and meanings:

  • CANCELLED -- A user cancelled the run
  • COMPLETE -- The run successfully completed. A human review completed if it was required. Results are retrievable, but some fields may have failed and have the value ERROR.
  • FAILED -- The run failed to complete
  • PAUSED -- This status is reserved for future use
  • RUNNING -- The run is in progress and is not paused
  • STOPPED_AT_CHECKPOINT -- A validation error has paused the run for human review
start_timestampinteger

When the run started, in Unix time nanoseconds.

finish_timestampinteger nullable

When the run finished, in Unix time nanoseconds. null if run is still in progress.

msgstring nullable

Message about the run.

batch_idinteger nullable

The batch ID used as input for this run.

input_dirstring nullable

The path of the input folder used for this run.

app_idstring nullable

The app ID of the app that was run.

deployment_idstring nullable

The deployment ID used for this run.

tagsstring[] nullable

List of string tags attached to this run.