How to get an execution plan with a remote backend

Introduction

There may be cases where you may want to output the execution plan with a remote backend with Terraform Enterprise and HCP Terraform. The execution plan can be downloaded in JSON format using the plans API. 

Expected Outcome

Retrieve the execution plan using the plans API. 

Prerequisites

• use a remote backend
• admin permissions for the workspace

Procedure

• Collect the run-id , this is listed in the "Run Details" from the workspace.
• Retrieve the plan-id, using the  runs API

Note: Replace the hostname in the examples below with your TFE hostname or if using HCP Terraform hostname should be app.terraform.io

• Example:
  

  $ curl \
  --header "Authorization: Bearer $TOKEN" \
  https://<hostname>/api/v2/runs/run-XXXXXXXXXXXXXXXX
       :                      :
    "plan": {
      "data": {
        "id": "plan-YYYYYYYYYYYYYYYY",
        "type": "plans"
      },

• Using the plan-id ,  retrieve the json execution plan

  curl --header "Authorization: Bearer $TOKEN" \
  --header "Content-Type: application/vnd.api+json" \
  --location https://<hostname>/api/v2/plans/plan-YYYYYYYYYYYYYYYY/json-output

Note : The JSON plan contains potentially sensitive information, including the values of sensitive variables and copies of the prior and post-refresh state. This is why the JSON plan isn't accessible without elevated permissions.

Additional Information

Documentation:

• Show a plan

• Get run details