v2

latestOpenAPI 3.1.02026-08-06276982.8 KB
runs

List runs

Return a list of runs. Use query parameters to filter results.

get/v2/apps/runs

Query parameters

app_idstring

Filter runs by app ID.

app_namestring

Filter runs by app name.

deployment_idstring

Filter runs by deployment ID.

usernamestring

Filter runs initiated by the specified user (username).

run_idstring

Filter specific run by run ID.

statusstring[]

Filter jobs by status, such as COMPLETE, RUNNING, or FAILED.

output_workspacesstring[]

Filter runs by the run's output workspace. By default, all runs across all workspaces you have access to are returned, use this query parameter to filter by specific workspace names. You must have access to the named workspaces.

from_timestampinteger

Filter runs starting from this timestamp. Timestamp in Unix time in seconds. Defaults to 24 hours before the current time.

to_timestampinteger

Filter runs up to this timestamp. Timestamp in Unix time in seconds. Defaults to the current time.

limitinteger

Number of results to return.

offsetinteger

Offset of the first result to return.

sort_by'start_timestamp' | 'status'

Field to sort results by.

order'ASCENDING' | 'DESCENDING'

Order of sorting, such as ASCENDING or DESCENDING.

Headers

Authorizationstring required

Bearer HTTP authentication.

IB-Contextstring

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

Response

A list of all runs.