• Overview
    • Enforce Policy as Code
    • Infrastructure as Code
    • Inject Secrets into Terraform
    • Integrate with Existing Workflows
    • Manage Kubernetes
    • Manage Virtual Machine Images
    • Multi-Cloud Deployment
    • Network Infrastructure Automation
    • Terraform CLI
    • Terraform Cloud
    • Terraform Enterprise
  • Registry
  • Tutorials
    • About the Docs
    • Intro to Terraform
    • Configuration Language
    • Terraform CLI
    • Terraform Cloud
    • Terraform Enterprise
    • Provider Use
    • Plugin Development
    • Registry Publishing
    • Integration Program
    • Terraform Tools
    • CDK for Terraform
    • Glossary
  • Community
GitHubTerraform Cloud
Download

    Terraform Cloud and Enterprise

  • Overview
  • Plans and Features
  • Getting Started
    • API Docs template
    • Overview
    • Account
    • Agent Pools
    • Agent Tokens
    • Applies
    • Audit Trails
    • Comments
    • Configuration Versions
    • Cost Estimates
    • Feature Sets
    • Invoices
    • IP Ranges
    • Notification Configurations
    • OAuth Clients
    • OAuth Tokens
    • Organizations
    • Organization Memberships
    • Organization Tags
    • Organization Tokens
    • Plan Exports
    • Plans
    • Policies
    • Policy Checks
    • Policy Sets
    • Policy Set Parameters
      • Modules
      • Providers
      • Private Provider Versions and Platforms
      • GPG Keys
    • Runs
      • Run Tasks
      • Stages and Results
      • Custom Integration
    • Run Triggers
    • SSH Keys
    • State Versions
    • State Version Outputs
    • Subscriptions
    • Team Access
    • Team Membership
    • Team Tokens
    • Teams
    • User Tokens
    • Users
    • Variables
    • VCS Events
    • Workspaces
    • Workspace-Specific Variables
    • Workspace Resources
    • Variable Sets
      • Overview
      • Module Sharing
      • Organizations
      • Runs
      • Settings
      • Terraform Versions
      • Users
      • Workspaces
    • Changelog
    • Stability Policy
    • Overview
    • Creating Workspaces
    • Naming
    • Terraform Configurations
      • Overview
      • Managing Variables
      • Overview
      • VCS Connections
      • Access
      • Drift Detection
      • Notifications
      • SSH Keys for Modules
      • Run Triggers
      • Run Tasks
    • Terraform State
    • JSON Filtering
    • Remote Operations
    • Viewing and Managing Runs
    • Run States and Stages
    • Run Modes and Options
    • UI/VCS-driven Runs
    • API-driven Runs
    • CLI-driven Runs
    • The Run Environment
    • Installing Software
    • Users
    • Teams
    • Organizations
    • Permissions
    • Two-factor Authentication
    • API Tokens
      • Overview
      • Microsoft Azure AD
      • Okta
      • SAML
      • Linking a User Account
      • Testing
    • Overview
    • GitHub.com
    • GitHub.com (OAuth)
    • GitHub Enterprise
    • GitLab.com
    • GitLab EE and CE
    • Bitbucket Cloud
    • Bitbucket Server and Data Center
    • Azure DevOps Services
    • Azure DevOps Server
    • Troubleshooting
    • Overview
    • Adding Public Providers and Modules
    • Publishing Private Providers
    • Publishing Private Modules
    • Using Providers and Modules
    • Configuration Designer
  • Migrating to Terraform Cloud
    • Overview
    • Using Sentinel with Terraform 0.12
    • Manage Policies
    • Enforce and Override Policies
    • Mocking Terraform Sentinel Data
    • Working With JSON Result Data
      • Overview
      • tfconfig
      • tfconfig/v2
      • tfplan
      • tfplan/v2
      • tfstate
      • tfstate/v2
      • tfrun
    • Example Policies
    • Overview
    • AWS
    • GCP
    • Azure
      • Overview
      • Service Catalog
      • Admin Guide
      • Developer Reference
      • Example Customizations
      • V1 Setup Instructions
    • Splunk Integration
    • Kubernetes Integration
    • Run Tasks Integration
    • Overview
    • IP Ranges
    • Data Security
    • Security Model
    • Overview
    • Part 1: Overview of Our Recommended Workflow
    • Part 2: Evaluating Your Current Provisioning Practices
    • Part 3: How to Evolve Your Provisioning Practices
    • Part 3.1: From Manual Changes to Semi-Automation
    • Part 3.2: From Semi-Automation to Infrastructure as Code
    • Part 3.3: From Infrastructure as Code to Collaborative Infrastructure as Code
    • Part 3.4: Advanced Workflow Improvements

  • Terraform Cloud Agents

  • Terraform Enterprise Admin

  • Other Docs

  • Intro to Terraform
  • Configuration Language
  • Terraform CLI
  • Terraform Cloud
  • Terraform Enterprise
  • Provider Use
  • Plugin Development
  • Registry Publishing
  • Integration Program
  • Terraform Tools
  • CDK for Terraform
  • Glossary
Type '/' to Search

»State Version Outputs API

State version outputs are the output values from a Terraform state file. They include the name and value of the output, as well as a sensitive boolean if the value should be hidden by default in UIs.

»List State Version Outputs

GET /state-versions/:state_version_id/outputs

Listing state version outputs requires permission to read state outputs for the workspace. (More about permissions.)

ParameterDescription
:state_version_idThe ID of the desired state version.
StatusResponseReason
200JSON API documentSuccessfully returned a list of outputs for the given state version.
404JSON API error objectState version not found, or user unauthorized to perform action.

»Query Parameters

This endpoint supports pagination with standard URL query parameters. Remember to percent-encode [ as %5B and ] as %5D if your tooling doesn't automatically encode URLs.

ParameterDescription
page[number]Optional. If omitted, the endpoint will return the first page.
page[size]Optional. If omitted, the endpoint will return 20 state version outputs per page.

»Sample Request

curl \
  --header "Authorization: Bearer $TOKEN" \
  --header "Content-Type: application/vnd.api+json" \
  https://app.terraform.io/api/v2/state-versions/sv-SDboVZC8TCxXEneJ/outputs
curl \
  --header "Authorization: Bearer $TOKEN" \
  --header "Content-Type: application/vnd.api+json" \
  https://app.terraform.io/api/v2/state-versions/sv-SDboVZC8TCxXEneJ/outputs

»Sample Response

{
  "data": [
    {
      "id": "wsout-xFAmCR3VkBGepcee",
      "type": "state-version-outputs",
      "attributes": {
        "name": "fruits",
        "sensitive": false,
        "type": "array",
        "value": [
          "apple",
          "strawberry",
          "blueberry",
          "rasberry"
        ]
      },
      "links": {
        "self": "/api/v2/state-version-outputs/wsout-xFAmCR3VkBGepcee"
      }
    },
    {
      "id": "wsout-vspuB754AUNkfxwo",
      "type": "state-version-outputs",
      "attributes": {
        "name": "vegetables",
        "sensitive": false,
        "type": "array",
        "value": [
          "carrots",
          "potato",
          "tomato",
          "onions"
        ]
      },
      "links": {
        "self": "/api/v2/state-version-outputs/wsout-vspuB754AUNkfxwo"
      }
    }
  ],
  "links": {
    "self": "https://app.terraform.io/api/v2/state-versions/sv-SVB5wMrDL1XUgJ4G/outputs?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "first": "https://app.terraform.io/api/v2/state-versions/sv-SVB5wMrDL1XUgJ4G/outputs?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "prev": null,
    "next": null,
    "last": "https://app.terraform.io/api/v2/state-versions/sv-SVB5wMrDL1XUgJ4G/outputs?page%5Bnumber%5D=1&page%5Bsize%5D=20"
  },
  "meta": {
    "pagination": {
      "current-page": 1,
      "page-size": 20,
      "prev-page": null,
      "next-page": null,
      "total-pages": 1,
      "total-count": 2
    }
  }
}
{
  "data": [
    {
      "id": "wsout-xFAmCR3VkBGepcee",
      "type": "state-version-outputs",
      "attributes": {
        "name": "fruits",
        "sensitive": false,
        "type": "array",
        "value": [
          "apple",
          "strawberry",
          "blueberry",
          "rasberry"
        ]
      },
      "links": {
        "self": "/api/v2/state-version-outputs/wsout-xFAmCR3VkBGepcee"
      }
    },
    {
      "id": "wsout-vspuB754AUNkfxwo",
      "type": "state-version-outputs",
      "attributes": {
        "name": "vegetables",
        "sensitive": false,
        "type": "array",
        "value": [
          "carrots",
          "potato",
          "tomato",
          "onions"
        ]
      },
      "links": {
        "self": "/api/v2/state-version-outputs/wsout-vspuB754AUNkfxwo"
      }
    }
  ],
  "links": {
    "self": "https://app.terraform.io/api/v2/state-versions/sv-SVB5wMrDL1XUgJ4G/outputs?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "first": "https://app.terraform.io/api/v2/state-versions/sv-SVB5wMrDL1XUgJ4G/outputs?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "prev": null,
    "next": null,
    "last": "https://app.terraform.io/api/v2/state-versions/sv-SVB5wMrDL1XUgJ4G/outputs?page%5Bnumber%5D=1&page%5Bsize%5D=20"
  },
  "meta": {
    "pagination": {
      "current-page": 1,
      "page-size": 20,
      "prev-page": null,
      "next-page": null,
      "total-pages": 1,
      "total-count": 2
    }
  }
}

»Show a State Version Output

GET /state-version-outputs/:state_version_output_id

ParameterDescription
:state_version_output_idThe ID of the desired state version output.

State version output IDs must be obtained from a state version object. When requesting a state version, you can optionally add ?include=outputs to include full details for all of that state version's outputs.

StatusResponseReason
200JSON API document (type: "state-version-outputs")Success.
404JSON API error objectState version output not found or user not authorized.

»Sample Request

curl \
  --header "Authorization: Bearer $TOKEN" \
  https://app.terraform.io/api/v2/state-version-outputs/wsout-J2zM24JPFbfc7bE5
curl \
  --header "Authorization: Bearer $TOKEN" \
  https://app.terraform.io/api/v2/state-version-outputs/wsout-J2zM24JPFbfc7bE5

»Sample Response

{
  "data": {
    "id": "wsout-J2zM24JPFbfc7bE5",
    "type": "state-version-outputs",
    "attributes": {
      "name": "flavor",
      "sensitive": false,
      "type": "string",
      "value": "Peanut Butter"
    },
    "links": {
      "self": "/api/v2/state-version-outputs/wsout-J2zM24JPFbfc7bE5"
    }
  }
}
{
  "data": {
    "id": "wsout-J2zM24JPFbfc7bE5",
    "type": "state-version-outputs",
    "attributes": {
      "name": "flavor",
      "sensitive": false,
      "type": "string",
      "value": "Peanut Butter"
    },
    "links": {
      "self": "/api/v2/state-version-outputs/wsout-J2zM24JPFbfc7bE5"
    }
  }
}

»Show Current State Version Outputs for a Workspace

This endpoint allows organization users, who do not have permissions to read state versions, to fetch the latest output values for a workspace. (More about permissions.)

Note: Sensitive values are not revealed and will be returned as null. To fetch an output including sensitive values see Show a State Version Output.

GET /workspaces/:workspace_id/current-state-version-outputs

ParameterDescription
:workspace_idThe ID of the workspace to read outputs from.
StatusResponseReason
200JSON API document (type: "state-version-outputs")Successfully returned a list of outputs for the given workspace.
404JSON API error objectState version outputs not found or user not authorized.

»Sample Request

curl \
  --header "Authorization: Bearer $TOKEN" \
  --header "Content-Type: application/vnd.api+json" \
  https://app.terraform.io/api/v2/workspaces/ws-G4zM299PFbfc10E5/current-state-version-outputs
curl \
  --header "Authorization: Bearer $TOKEN" \
  --header "Content-Type: application/vnd.api+json" \
  https://app.terraform.io/api/v2/workspaces/ws-G4zM299PFbfc10E5/current-state-version-outputs

»Sample Response

{
  "data": [
    {
      "id": "wsout-J2zM24JPFbfc7bE5",
      "type": "state-version-outputs",
      "attributes": {
        "name": "flavor",
        "sensitive": false,
        "type": "string",
        "value": "Peanut Butter"
      },
      "links": {
        "self": "/api/v2/state-version-outputs/wsout-J2zM24JPFbfc7bE5"
      }
    },
    {
      "id": "wsout-FLzM23Gcd5f37bE5",
      "type": "state-version-outputs",
      "attributes": {
        "name": "recipe",
        "sensitive": true,
        "type": "string",
        "value": null 
      },
      "links": {
        "self": "/api/v2/state-version-outputs/wsout-FLzM23Gcd5f37bE5"
      }
    }
  ]
}
{
  "data": [
    {
      "id": "wsout-J2zM24JPFbfc7bE5",
      "type": "state-version-outputs",
      "attributes": {
        "name": "flavor",
        "sensitive": false,
        "type": "string",
        "value": "Peanut Butter"
      },
      "links": {
        "self": "/api/v2/state-version-outputs/wsout-J2zM24JPFbfc7bE5"
      }
    },
    {
      "id": "wsout-FLzM23Gcd5f37bE5",
      "type": "state-version-outputs",
      "attributes": {
        "name": "recipe",
        "sensitive": true,
        "type": "string",
        "value": null 
      },
      "links": {
        "self": "/api/v2/state-version-outputs/wsout-FLzM23Gcd5f37bE5"
      }
    }
  ]
}
github logoEdit this page
  • Overview
  • Docs
  • Extend
  • Privacy
  • Security
  • Press Kit
  • Consent Manager