terraform/website/source/docs/enterprise/api/runs.html.md

layout	page_title	sidebar_current	description
api	Runs API	docs-enterprise-api-runs	Runs in Terraform Enterprise represents a two step Terraform plan and a subsequent apply.

Runs API

Runs in Terraform Enterprise represents a two step Terraform plan and a subsequent apply.

Runs are queued under environments and require a two-step confirmation workflow. However, environments can be configured to auto-apply to avoid this.

Run Attributes

Attribute	Description	Required
destroy	If set to true, this run will be a destroy plan.	No

Actions

The following actions can be performed on this resource.

Queue a run

POST /api/v1/environments/:username/:name/plan

Examples

Queueing a new run

Starts a new run (plan) in the environment. Requires a configuration version to be present on the environment to succeed, but will otherwise 404.

$ curl %{ATLAS_URL}/api/v1/environments/%{DEFAULT_USERNAME}/test/plan \
    -X POST \
    -d "" \
    -H "X-Atlas-Token: $ATLAS_TOKEN"