SCscalr
runs

Get a Run

Changed on

Show details of a specific run.

get/runs/{run}

Request

  • Base URL
    https://example.scalr.io/api/iacp/v3
  • URL
    https://example.scalr.io/api/iacp/v3/runs/{run}
  • Auth
    HTTP bearer

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.

includedobject[]
metaobject

Changes

  • d3e1dc85657aRevision changes
    • warning

      added the new mcp enum value to the ////// response property for the response status

    • info

      added the optional property // to the response with the status