Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-24340250799.5 KB
runs

List Runs Queue

This endpoint lists Runs Queue on allowed scopes.

get/runs-queue

Query parameters

page[number]string

Page number

page[size]string

Page size

includestring[]

The comma-separated list of relationship paths.

filter[workspace]string

The workspace ID to list runs for.

filter[account]string

The account ID to list runs for.

filter[environment]string

The environment ID to list runs for.

filter[run]string

The comma-separated list of run IDs.

filter[status]string

The run status filter.

filter[source]string

The run source filter.

filter[vcs-revision]string

Commit sha that affected runs

filter[created-by]string

The ID of the User who triggered this run

filter[created-by-run]string

The ID of the Run which triggered this run

filter[env-or-ws]string

The list of environment or workspaces IDs to match

filter[created-at]string

The run created at filter.

querystring

Query string

filter[is-dry]string

The is dry runs filter.

scheduledstring

List only runs that are scheduled.

filter[tag]string

Filter runs by tags.

filter[resource-drifts]string

Filter the runs by drifted resources count.

appliesstring

The comma-separated list of fields to return in response for Apply resource.

configuration-versionsstring

The comma-separated list of fields to return in response for ConfigurationVersion resource.

cost-estimatesstring

The comma-separated list of fields to return in response for CostEstimate resource.

environmentsstring

The comma-separated list of fields to return in response for Environment resource.

plansstring

The comma-separated list of fields to return in response for Plan resource.

policy-checksstring

The comma-separated list of fields to return in response for PolicyCheck resource.

runsstring

The comma-separated list of fields to return in response for Run resource.

status-transitionsstring

The comma-separated list of fields to return in response for StatusTransition resource.

tagsstring

The comma-separated list of fields to return in response for Tag resource.

usersstring

The comma-separated list of fields to return in response for User resource.

vcs-revisionsstring

The comma-separated list of fields to return in response for VcsRevision resource.

workspacesstring

The comma-separated list of fields to return in response for Workspace resource.

The value of the fields[resource-type] parameter is a comma-separated list that refers to the name of the fields to be returned for the resource. An empty value indicates that no fields should be returned.

Response

Success.