Skip to main content
POST
ListRuns

Authorizations

Authorization
string
header
required

A user session token or personal API key.

Headers

Connect-Protocol-Version
number
required

Define the version of the Connect protocol

Example:

1

Connect-Timeout-Ms
number

Define the timeout, in ms

Example:

1000

Body

application/json
pageSize
integer<int32> | null
Required range: 0 <= x <= 200
pageToken
string | null
query
string
names
string[]

When nonempty, return only these Run resource names.

states
enum<string>[]

Match any listed state; combined with names using AND.

Available options:
STATE_UNSPECIFIED,
STATE_RUNNING,
STATE_COMPLETED,
STATE_FAILED,
STATE_CANCELLED,
STATE_CANCELLING
creators
string[]
order
enum<string>
Available options:
RUN_ORDER_UNSPECIFIED,
RUN_ORDER_CREATED_DESCENDING,
RUN_ORDER_NAME_ASCENDING,
RUN_ORDER_DURATION_DESCENDING
filter
filter · object

Boolean filter tree (and/or/not/predicate) over name, workspace and created_by. Combined with other restrictions before ordering and pagination.

Response

Success

runs
Run · object[]
nextPageToken
string