v1

latestOpenAPI 3.0.0Apache 2.02026-07-24340250799.5 KB
runs

Get a Run

Show details of a specific run.

get/runs/{run}

Path parameters

runstring required

The ID of the run to show.

Query parameters

includestring[]

The comma-separated list of relationship paths.

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.