» Plans API

A plan represents the execution plan of a Run in a Terraform workspace.

» Attributes

» Plan States

The plan state is found in data.attributes.status, and you can reference the following list of possible states.

State Description
pending The initial status of a plan once it has been created.
managed_queued/queued The plan has been queued, awaiting backend service capacity to run terraform.
running The plan is running.
errored The plan has errored. This is a final state.
canceled The plan has been canceled. This is a final state.
finished The plan has completed sucessfully. This is a final state.
unreachable The plan will not run. This is a final state.

» Show a plan

GET /plans/:id

Parameter Description
id The ID of the plan to show.

There is no endpoint to list plans. You can find the ID for a plan in the relationships.plan property of a run object.

Status Response Reason
200 JSON API document (type: "plans") The request was successful
404 JSON API error object Plan not found, or user unauthorized to perform action

» Sample Request

curl \
  --header "Authorization: Bearer $TOKEN" \
  --header "Content-Type: application/vnd.api+json" \

» Sample Response

  "data": {
    "id": "plan-8F5JFydVYAmtTjET",
    "type": "plans",
    "attributes": {
      "has-changes": true,
      "resource-additions": 0,
      "resource-changes": 1,
      "resource-destructions": 0,
      "status": "finished",
      "status-timestamps": {
        "queued-at": "2018-07-02T22:29:53+00:00",
        "pending-at": "2018-07-02T22:29:53+00:00",
        "started-at": "2018-07-02T22:29:54+00:00",
        "finished-at": "2018-07-02T22:29:58+00:00"
      "log-read-url": "https://archivist.terraform.io/v1/object/dmF1bHQ6djE6OFA1eEdlSFVHRSs4YUcwaW83a1dRRDA0U2E3T3FiWk1HM2NyQlNtcS9JS1hHN3dmTXJmaFhEYTlHdTF1ZlgxZ2wzVC9kVTlNcjRPOEJkK050VFI3U3dvS2ZuaUhFSGpVenJVUFYzSFVZQ1VZYno3T3UyYjdDRVRPRE5pbWJDVTIrNllQTENyTndYd1Y0ak1DL1dPVlN1VlNxKzYzbWlIcnJPa2dRRkJZZGtFeTNiaU84YlZ4QWs2QzlLY3VJb3lmWlIrajF4a1hYZTlsWnFYemRkL2pNOG9Zc0ZDakdVMCtURUE3dDNMODRsRnY4cWl1dUN5dUVuUzdnZzFwL3BNeHlwbXNXZWRrUDhXdzhGNnF4c3dqaXlZS29oL3FKakI5dm9uYU5ZKzAybnloREdnQ3J2Rk5WMlBJemZQTg"
    "relationships": {
      "state-versions": {
        "data": []
    "links": {
      "self": "/api/v2/plans/plan-8F5JFydVYAmtTjET",
      "json-output": "/api/v2/plans/plan-8F5JFydVYAmtTjET/json-output"

» Retrieve the JSON execution plan

GET /plans/:id/json-output

GET /runs/:id/plan/json-output

These endpoints generate a temporary authenticated URL to the location of the JSON formatted execution plan. When successful, this endpoint responds with a temporary redirect that should be followed. If using a client that can follow redirects, you can use this endpoint to save the .json file locally without needing to save the temporary URL.

This temporary URL provided by the redirect has a life of 1 minute, and should not be relied upon beyond the initial request. If you need repeat access, you should use this endpoint to generate a new URL each time.

Status Response Reason
204 No Content Plan JSON supported, but plan has not yet completed.
307 Temporary Redirect Plan JSON found and temporary download URL generated
422 JSON API error object Plan does not use a supported version of terraform (< 0.12.X)

» Sample Request

curl \
  --header "Authorization: Bearer $TOKEN" \
  --header "Content-Type: application/vnd.api+json" \
  --location \
  https://app.terraform.io/api/v2/plans/plan-8F5JFydVYAmtTjET/json-output |
  > json-output.json