API referenceRuns

List runs

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

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

IB-ContextstringOptional

Specify whether to use your community account or organization account to complete the request. To use your community account, define as your user ID. To use your organization account, define as your organization ID. If unspecified, defaults to community account context. See Authorization and context identification for details.

Query parameters

app_idstringOptional
Filter runs by app ID.
app_namestringOptional
Filter runs by app name.
deployment_idstringOptional
Filter runs by deployment ID.
usernamestringOptional

Filter runs initiated by the specified user (username).

run_idstringOptional
Filter specific run by run ID.
statuslist of stringsOptional
Filter jobs by status, such as COMPLETE, RUNNING, or FAILED.
output_workspaceslist of stringsOptional
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_timestampintegerOptional
Filter runs starting from this timestamp. Timestamp in Unix time in seconds. Defaults to 24 hours before the current time.
to_timestampintegerOptional
Filter runs up to this timestamp. Timestamp in Unix time in seconds. Defaults to the current time.
limitintegerOptional
Number of results to return.
offsetintegerOptional
Offset of the first result to return.
sort_byenumOptional
Field to sort results by.
Allowed values:
orderenumOptional
Order of sorting, such as ASCENDING or DESCENDING.
Allowed values:

Response

A list of all runs.
runslist of objects or null