» 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.

» Show a State Version Output

GET /state-version-outputs/:state_version_output_id

Parameter Description
:state_version_output_id The 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.

Status Response Reason
200 JSON API document (type: "state-version-outputs") Success
404 JSON API error object State version output not found or user not authorized

» Sample Request

curl \
  --header "Authorization: Bearer $TOKEN" \

» 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"