SCscalr
runs

Create a Run

Changed on

A run performs terraform plan and apply using a configuration version and the workspace's current variables. If the configuration version is omitted, the run will be created using the workspace's latest configuration version. If you want to create a dry run, specify is-dry: true or reference configuration version with is-dry: true in the relationships.

post/runs

Request

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

Query parameters

vcs-user-idinteger

The ID of VCS user who triggered the run. It is for the internal use only.

vcs-task-idstring

The ID of a VCS task which triggered the run. Internal use only.

Request body

includedobject[]
metaobject

Response

Successfully created a run.

includedobject[]
metaobject

Changes

  • d3e1dc85657aRevision changes
    • warning

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

    • info

      added the new mcp enum value to the request property //////

    • info

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