---
updatedAt: 2026-05-28T08:16:45.000Z
agentTools:
  projectIndex: https://docs.scalr.io/llms.txt
---

# Get a Plan

Show details of a specific Terraform Plan stage.

# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "Plan": {
        "description": "Provides details of a Terraform plan operation.",
        "properties": {
          "attributes": {
            "properties": {
              "execution-details": {
                "additionalProperties": {
                  "type": "string"
                },
                "description": "Plan execution details.",
                "type": "object"
              },
              "has-changes": {
                "description": "Indicates if plan has proposed resource changes.",
                "type": "boolean"
              },
              "resource-additions": {
                "description": "The number of new resources that will be added.",
                "nullable": true,
                "type": "integer"
              },
              "resource-changes": {
                "description": "The number of resources that will be updated in place.",
                "nullable": true,
                "type": "integer"
              },
              "resource-destructions": {
                "description": "The number of resources that will be destroyed.",
                "nullable": true,
                "type": "integer"
              },
              "status": {
                "description": "The Plan's current status.\n\nTransient states:\n* `pending` - Plan has been created but not yet queued.\n* `queued` - Queued and waiting for capacity/and or quota to be available.\n* `running` - Running.\n\nFinal states:\n* `canceled` - Plan canceled in some way.\n* `errored` - An error occurred during the plan. See `output` for details.\n* `finished` - Plan completed successfully.\n* `unreachable` - Plan will not be run.",
                "enum": [
                  "pending",
                  "queued",
                  "running",
                  "finished",
                  "canceled",
                  "errored",
                  "unreachable"
                ],
                "type": "string"
              },
              "status-timestamps": {
                "additionalProperties": {
                  "format": "date-time",
                  "type": "string"
                },
                "description": "Date/Time of transition to each status that has occurred.",
                "type": "object"
              }
            },
            "type": "object"
          },
          "id": {
            "readOnly": true,
            "type": "string"
          },
          "links": {
            "properties": {
              "json-output": {
                "description": "URL to retrieve the JSON execution plan",
                "nullable": true,
                "type": "string"
              },
              "output": {
                "description": "Link to download the raw output of the terraform plan.",
                "nullable": true,
                "type": "string"
              },
              "self": {
                "type": "string"
              }
            },
            "readOnly": true,
            "type": "object"
          },
          "type": {
            "enum": [
              "plans"
            ],
            "type": "string"
          }
        },
        "required": [
          "type"
        ],
        "type": "object"
      },
      "PlanDocument": {
        "description": "JSON:API Document.\n\nsee: https://jsonapi.org/format/#document-structure",
        "properties": {
          "data": {
            "$ref": "#/components/schemas/Plan"
          },
          "included": {
            "items": {
              "type": "object"
            },
            "readOnly": true,
            "type": "array"
          },
          "meta": {
            "readOnly": true,
            "type": "object"
          }
        },
        "type": "object"
      }
    },
    "securitySchemes": {
      "API-Key": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "info": {
    "description": "Scalr IACP API",
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0"
    },
    "title": "Scalr IACP API",
    "version": "unversioned"
  },
  "openapi": "3.0.0",
  "paths": {
    "/plans/{plan}": {
      "get": {
        "description": "Show details of a specific Terraform Plan stage.",
        "operationId": "get_plan",
        "parameters": [
          {
            "description": "The ID of the plan.",
            "in": "path",
            "name": "plan",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/vnd.api+json": {
                "examples": {
                  "default": {
                    "value": "{\n  \"data\": {\n    \"attributes\": {\n      \"has-changes\": true,\n      \"resource-additions\": 10,\n      \"resource-changes\": 0,\n      \"resource-destructions\": 0,\n      \"status\": \"finished\",\n      \"status-timestamps\": {\n        \"finished-at\": \"2020-10-05T10:39:09Z\",\n        \"queued-at\": \"2020-10-05T10:38:34Z\",\n        \"started-at\": \"2020-10-05T10:38:38Z\"\n      }\n    },\n    \"id\": \"plan-t4djd75nc170hhg\",\n    \"links\": {\n      \"self\": \"https://my.scalr.io/api/iacp/v3/plans/plan-t4djd75nc170hhg\",\n      \"output\": \"https://my.scalr.io/api/iacp/v3/blobs/eyJhbGciOiJQQkVTMi1IUzUxMitBMjU2S1ciLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIiwicDJjIjo4MTkyLCJwMnMiOiI2UzllOVJGdGJjNnNpVmx5VllMY1lnIn0.DUal2j6Btnu9Ji7x6mw-gJ86Hnu80fxUqivacQHoTQgjPUxZh4dhkWNR_MjMJ8R69qOJBOugne4M2Vkg7Eqwu8JAJ9HYr43v.XusmYBeTnbO1vIH4HYf78w.E4qiD2CMSw8j9bY67i-4hq6GWJkfkKS8aYEIAUTKvGgrRF7MswpXozOgsejWr-vjLEEHJzOnQ3O929VVe9brG4xSXTxUsnwPy0um1De80kPt7mrZoiT9c_vhhEIIZjSC.weG6Pglv55efpn-haFrgTLPEPcoRC6Otwz4wyVkLuQM\"\n    },\n    \"relationships\": {},\n    \"type\": \"plans\"\n  },\n  \"included\": null,\n  \"meta\": null\n}"
                  }
                },
                "schema": {
                  "$ref": "#/components/schemas/PlanDocument"
                }
              }
            },
            "description": "Success."
          },
          "403": {
            "description": "Plan not found or user unauthorized to perform action."
          },
          "4XX": {
            "description": "Client error."
          },
          "5XX": {
            "description": "Server error."
          }
        },
        "summary": "Get a Plan",
        "tags": [
          "plans"
        ],
        "x-resource": "Plan",
        "x-service": "tf-api"
      }
    }
  },
  "security": [
    {
      "API-Key": []
    }
  ],
  "servers": [
    {
      "url": "https://{Domain}/api/iacp/v3",
      "variables": {
        "Domain": {
          "default": "example.scalr.io",
          "description": "Domain where Scalr is hosted"
        }
      }
    }
  ]
}
```

# Sibling pages

* [JSON Output](https://docs.scalr.io/scalr/reference/get_json_output.md)
* [Plan Log](https://docs.scalr.io/scalr/reference/get_plan_log.md)
* [Sanitized JSON Output](https://docs.scalr.io/scalr/reference/get_sanitized_json_output.md)