State versions API reference
Attributes
State version API objects represent an instance of Terraform state data, but do not directly contain the stored state. Instead, they contain information about the state, its properties, and its contents, and include one or more URLs from which the state can be downloaded.
Some of the information returned in a state version API object might bepopulated asynchronously by HCP Terraform. This includes resources, modules, providers, and thestate version outputs associated with the state version. These values might not be immediately available after the state version is uploaded. Theresources-processed property on the state version object indicates whether or not HCP Terraform has finished any necessary asynchronous processing. If you need to use these values, be sure to wait forresources-processed to becometrue before assuming that the values are in fact empty.
| Attribute | Description |
|---|---|
billable-rum-count | Count of billable Resources Under Management (RUM). Only present for organization members on HCP Terraform RUM plans with visibility of billable RUM usage. |
hosted-json-state-download-url | A URL from which you can download the state data in astable format appropriate for external integrations to consume. Only available if the state was created by Terraform 1.3+. |
hosted-state-download-url | A URL from which you can download the raw state data, in the format used internally by Terraform. |
hosted-json-state-upload-url | A URL to which you can upload state data in astable format appropriate for external integrations to consume. You can upload JSON state content once per state version. |
hosted-state-upload-url | A URL to which you can upload state data in the format used Terraform uses internally. You can upload state data once per state version. |
modules | Extracted information about the Terraform modules in this state data. Populated asynchronously. |
providers | Extracted information about the Terraform providers used for resources in this state data. Populated asynchronously. |
intermediate | A boolean flag that indicates the state version is a snapshot and not yet set as the current state version for a workspace. The last intermediate state version becomes the current state version when the workspace is unlocked. Not yet supported in Terraform Enterprise. |
resources | Extracted information about the resources in this state data. Populated asynchronously. |
resources-processed | A Boolean flag indicating whether HCP Terraform has finished asynchronously extracting outputs, resources, and other information about this state data. |
serial | The serial number of this state instance, which increases every time Terraform creates new state in the workspace. |
state-version | The version of the internal state format used for this state. Different Terraform versions read and write different format versions, but it only changes infrequently. |
status | Indicates a state version's content uploadstatus. This status can bepending,finalized ordiscarded. |
terraform-version | The Terraform version that created this state. Populated asynchronously. |
vcs-commit-sha | The SHA of the configuration commit used in the Terraform run that produced this state. Only present if the workspace is connected to a VCS repository. |
vcs-commit-url | A link to the configuration commit used in the Terraform run that produced this state. Only present if the workspace is connected to a VCS repository. |
State Version Status
The state version status is found indata.attributes.status, and you can reference the following list of possible statuses.A state version created through the API or CLI will only be listed in the UI if it is has afinalized status.
| State | Description |
|---|---|
pending | Indicates that a state version has been created but the state data is not encoded within the request. Pending state versions do not contain state data and do not appear in the UI. You cannot unlock the workspace until the latest state version is finalized. |
finalized | Indicates that the state version has been successfully uploaded to HCP Terraform or that the state version was created with a validstate attribute. |
discarded | The state version was discarded because it was superseded by a newer state version before it could be uploaded. |
backing_data_soft_deleted | Enterprise The backing files associated with this state version are marked for garbage collection. Terraform permanently deletes backing files associated with this state version after a set number of days, but you can restore the backing data associated with it before it is permanently deleted. |
backing_data_permanently_deleted | Enterprise The backing files associated with this state version have been permanently deleted and can no longer be restored. |
Create a State Version
Hands-on: Try theVersion Remote State with the HCP Terraform API tutorial to download a remote state file and use the Terraform API to create a new state version.
POST /workspaces/:workspace_id/state-versions
| Parameter | Description |
|---|---|
:workspace_id | The workspace ID to create the new state version in. Obtain this from theworkspace settings or theShow Workspace endpoint. |
Creates a state version and sets it as the current state version for the given workspace. The workspace must be locked by the user creating a state version. The workspace may be lockedwith the API orwith the UI. This is most useful for migrating existing state from Terraform Community edition into a new HCP Terraform workspace.
Creating state versions requires permission to read and write state versions for the workspace. (More about permissions.)
Warning: Use caution when uploading state to workspaces that have already performed Terraform runs. Replacing state improperly can result in orphaned or duplicated infrastructure resources.
Note: For Free Tier organizations, HCP Terraform always retains at least the last 100 states (across all workspaces) and at least the most recent state for every workspace. Additional states beyond the last 100 are retained for six months, and are then deleted.
Note: You cannot access this endpoint withorganization tokens. You must access it with auser token orteam token.
| Status | Response | Reason |
|---|---|---|
| 201 | JSON API document | Successfully created a state version. |
| 404 | JSON API error object | Workspace not found, or user unauthorized to perform action. |
| 409 | JSON API error object | Conflict; check the error object for more information. |
| 412 | JSON API error object | Precondition failed; check the error object for more information. |
| 422 | JSON API error object | Malformed request body (missing attributes, wrong types, etc.). |
Request Body
This POST endpoint requires a JSON object with the following properties as a request payload.
Properties without a default value are required.
| Key path | Type | Default | Description |
|---|---|---|---|
data.type | string | Must be"state-versions". | |
data.attributes.serial | integer | The serial of the state version. Must match the serial value extracted from the raw state file. | |
data.attributes.md5 | string | An MD5 hash of the raw state version. | |
data.attributes.state | string | (nothing) | Optional Base64 encoded raw state file. If omitted, you must use the upload method below to complete the state version creation. The workspace may not be unlocked normally until the state version is uploaded. |
data.attributes.lineage | string | (nothing) | Optional Lineage of the state version. Should match the lineage extracted from the raw state file. Early versions of terraform did not have the concept of lineage, so this is an optional attribute. |
data.attributes.json-state | string | (nothing) | Optional Base64 encoded json state, as expressed byterraform show -json. SeeJSON Output Format for more details. |
data.attributes.json-state-outputs | string | (nothing) | Optional Base64 encoded output values as represented byterraform show -json (the contents of the values/outputs key). If provided, the workspace outputs populate immediately. If omitted, HCP Terraform populates the workspace outputs from the given state after a short time. |
data.relationships.run.data.id | string | (nothing) | Optional The ID of the run to associate with the state version. |
Sample Payload
{ "data": { "type":"state-versions", "attributes": { "serial": 1, "md5": "d41d8cd98f00b204e9800998ecf8427e", "lineage": "871d1b4a-e579-fb7c-ffdb-f0c858a647a7", "state": "...", "json-state": "...", "json-state-outputs": "..." }, "relationships": { "run": { "data": { "type": "runs", "id": "run-bWSq4YeYpfrW4mx7" } } } }}Sample Request
curl \ --header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ --request POST \ --data @payload.json \ https://app.terraform.io/api/v2/workspaces/ws-6fHMCom98SDXSQUv/state-versionsSample Response
{ "data": { "id": "sv-DmoXecHePnNznaA4", "type": "state-versions", "attributes": { "vcs-commit-sha": null, "vcs-commit-url": null, "created-at": "2018-07-12T20:32:01.490Z", "hosted-state-download-url": "https://archivist.terraform.io/v1/object/f55b739b-ff03-4716-b436-726466b96dc4", "hosted-json-state-download-url": "https://archivist.terraform.io/v1/object/4fde7951-93c0-4414-9a40-f3abc4bac490", "hosted-state-upload-url": null, "hosted-json-state-upload-url": null, "status": "finalized", "intermediate": true, "serial": 1 }, "links": { "self": "/api/v2/state-versions/sv-DmoXecHePnNznaA4" } }}Upload State and JSON State
You can upload state version content in the same request when creating a state version. However, westrongly recommend that you upload content separately.
PUT https://archivist.terraform.io/v1/object/<UNIQUE OBJECT ID>
HCP Terraform returns ahosted-state-upload-url orhosted-json-state-upload-url returned when you create astate-version. Once you upload state content, this URL is hidden on the resource andno longer available.
Sample Request
In the below example,@filename is the name of Terraform state file you wish to upload.
curl \ --header "Content-Type: application/octet-stream" \ --request PUT \ --data-binary @filename \ https://archivist.terraform.io/v1/object/4c44d964-eba7-4dd5-ad29-1ece7b99e8daList State Versions for a Workspace
GET /state-versions
Listing state versions requires permission to read state versions for the workspace. (More about permissions.)
Query Parameters
This endpoint supports paginationwith standard URL query parameters. Remember to percent-encode[ as%5B and] as%5D if your tooling doesn't automatically encode URLs.
| Parameter | Description |
|---|---|
filter[workspace][name] | Required The name of one workspace to list versions for. |
filter[organization][name] | Required The name of the organization that owns the desired workspace. |
filter[status] | Optional. Filter state versions by status:pending,finalized, ordiscarded. |
page[number] | Optional. If omitted, the endpoint will return the first page. |
page[size] | Optional. If omitted, the endpoint will return 20 state versions per page. |
Sample Request
curl \ --header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ "https://app.terraform.io/api/v2/state-versions?filter%5Bworkspace%5D%5Bname%5D=my-workspace&filter%5Borganization%5D%5Bname%5D=my-organization"Sample Response
{ "data": [ { "id": "sv-g4rqST72reoHMM5a", "type": "state-versions", "attributes": { "created-at": "2021-06-08T01:22:03.794Z", "size": 940, "hosted-state-download-url": "https://archivist.terraform.io/v1/object/...", "hosted-state-upload-url": null, "hosted-json-state-download-url": "https://archivist.terraform.io/v1/object/...", "hosted-json-state-upload-url": null, "status": "finalized", "intermediate": false, "modules": { "root": { "null-resource": 1, "data.terraform-remote-state": 1 } }, "providers": { "provider[\"terraform.io/builtin/terraform\"]": { "data.terraform-remote-state": 1 }, "provider[\"registry.terraform.io/hashicorp/null\"]": { "null-resource": 1 } }, "resources": [ { "name": "other_username", "type": "data.terraform_remote_state", "count": 1, "module": "root", "provider": "provider[\"terraform.io/builtin/terraform\"]" }, { "name": "random", "type": "null_resource", "count": 1, "module": "root", "provider": "provider[\"registry.terraform.io/hashicorp/null\"]" } ], "resources-processed": true, "serial": 9, "state-version": 4, "terraform-version": "0.15.4", "vcs-commit-url": "https://gitlab.com/my-organization/terraform-test/-/commit/abcdef12345", "vcs-commit-sha": "abcdef12345" }, "relationships": { "run": { "data": { "id": "run-YfmFLWpgTv31VZsP", "type": "runs" } }, "created-by": { "data": { "id": "user-onZs69ThPZjBK2wo", "type": "users" }, "links": { "self": "/api/v2/users/user-onZs69ThPZjBK2wo", "related": "/api/v2/runs/run-YfmFLWpgTv31VZsP/created-by" } }, "workspace": { "data": { "id": "ws-noZcaGXsac6aZSJR", "type": "workspaces" } }, "outputs": { "data": [ { "id": "wsout-V22qbeM92xb5mw9n", "type": "state-version-outputs" }, { "id": "wsout-ymkuRnrNFeU5wGpV", "type": "state-version-outputs" }, { "id": "wsout-v82BjkZnFEcscipg", "type": "state-version-outputs" } ] } }, "links": { "self": "/api/v2/state-versions/sv-g4rqST72reoHMM5a" } }, { "id": "sv-QYKf6GvNv75ZPTBr", "type": "state-versions", "attributes": { "created-at": "2021-06-01T21:40:25.941Z", "size": 819, "hosted-state-download-url": "https://archivist.terraform.io/v1/object/...", "hosted-state-upload-url": null, "hosted-json-state-download-url": "https://archivist.terraform.io/v1/object/...", "hosted-json-state-upload-url": null, "status": "finalized", "intermediate": false, "modules": { "root": { "data.terraform-remote-state": 1 } }, "providers": { "provider[\"terraform.io/builtin/terraform\"]": { "data.terraform-remote-state": 1 } }, "resources": [ { "name": "other_username", "type": "data.terraform_remote_state", "count": 1, "module": "root", "provider": "provider[\"terraform.io/builtin/terraform\"]" } ], "resources-processed": true, "serial": 8, "state-version": 4, "terraform-version": "0.15.4", "vcs-commit-url": "https://gitlab.com/my-organization/terraform-test/-/commit/12345abcdef", "vcs-commit-sha": "12345abcdef" }, "relationships": { "run": { "data": { "id": "run-cVtxks6R8wsjCZMD", "type": "runs" } }, "created-by": { "data": { "id": "user-onZs69ThPZjBK2wo", "type": "users" }, "links": { "self": "/api/v2/users/user-onZs69ThPZjBK2wo", "related": "/api/v2/runs/run-YfmFLWpgTv31VZsP/created-by" } }, "workspace": { "data": { "id": "ws-noZcaGXsac6aZSJR", "type": "workspaces" } }, "outputs": { "data": [ { "id": "wsout-MmqMhmht6jFmLRvh", "type": "state-version-outputs" }, { "id": "wsout-Kuo9TCHg3oDLDQqa", "type": "state-version-outputs" } ] } }, "links": { "self": "/api/v2/state-versions/sv-QYKf6GvNv75ZPTBr" } } ], "links": { "self": "https://app.terraform.io/api/v2/state-versions?filter%5Borganization%5D%5Bname%5D=hashicorp&filter%5Bworkspace%5D%5Bname%5D=my-workspace&page%5Bnumber%5D=1&page%5Bsize%5D=20", "first": "https://app.terraform.io/api/v2/state-versions?filter%5Borganization%5D%5Bname%5D=hashicorp&filter%5Bworkspace%5D%5Bname%5D=my-workspace&page%5Bnumber%5D=1&page%5Bsize%5D=20", "prev": null, "next": null, "last": "https://app.terraform.io.io/api/v2/state-versions?filter%5Borganization%5D%5Bname%5D=hashicorp&filter%5Bworkspace%5D%5Bname%5D=my-workspace&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": 10 } }}Fetch the Current State Version for a Workspace
GET /workspaces/:workspace_id/current-state-version
| Parameter | Description |
|---|---|
:workspace_id | The ID for the workspace whose current state version you want to fetch. Obtain this from theworkspace settings or theShow Workspace endpoint. |
Fetches the current state version for the given workspace. This state versionwill be the input state when running terraform operations.
Viewing state versions requires permission to read state versions for the workspace. (More about permissions.)
| Status | Response | Reason |
|---|---|---|
| 200 | JSON API document | Successfully returned current state version for the given workspace. |
| 404 | JSON API error object | Workspace not found, workspace does not have a current state version, or user unauthorized to perform action. |
Sample Request
curl \ --header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ https://app.terraform.io/api/v2/workspaces/ws-6fHMCom98SDXSQUv/current-state-versionSample Response
{ "data": { "id": "sv-g4rqST72reoHMM5a", "type": "state-versions", "attributes": { "billable-rum-count": 0, "created-at": "2021-06-08T01:22:03.794Z", "size": 940, "hosted-state-download-url": "https://archivist.terraform.io/v1/object/...", "hosted-state-upload-url": null, "hosted-json-state-download-url": "https://archivist.terraform.io/v1/object/...", "hosted-json-state-upload-url": null, "status": "finalized", "intermediate": false, "modules": { "root": { "null-resource": 1, "data.terraform-remote-state": 1 } }, "providers": { "provider[\"terraform.io/builtin/terraform\"]": { "data.terraform-remote-state": 1 }, "provider[\"registry.terraform.io/hashicorp/null\"]": { "null-resource": 1 } }, "resources": [ { "name": "other_username", "type": "data.terraform_remote_state", "count": 1, "module": "root", "provider": "provider[\"terraform.io/builtin/terraform\"]" }, { "name": "random", "type": "null_resource", "count": 1, "module": "root", "provider": "provider[\"registry.terraform.io/hashicorp/null\"]" } ], "resources-processed": true, "serial": 9, "state-version": 4, "terraform-version": "0.15.4", "vcs-commit-url": "https://gitlab.com/my-organization/terraform-test/-/commit/abcdef12345", "vcs-commit-sha": "abcdef12345" }, "relationships": { "run": { "data": { "id": "run-YfmFLWpgTv31VZsP", "type": "runs" } }, "created-by": { "data": { "id": "user-onZs69ThPZjBK2wo", "type": "users" }, "links": { "self": "/api/v2/users/user-onZs69ThPZjBK2wo", "related": "/api/v2/runs/run-YfmFLWpgTv31VZsP/created-by" } }, "workspace": { "data": { "id": "ws-noZcaGXsac6aZSJR", "type": "workspaces" } }, "outputs": { "data": [ { "id": "wsout-V22qbeM92xb5mw9n", "type": "state-version-outputs" }, { "id": "wsout-ymkuRnrNFeU5wGpV", "type": "state-version-outputs" }, { "id": "wsout-v82BjkZnFEcscipg", "type": "state-version-outputs" } ] } }, "links": { "self": "/api/v2/state-versions/sv-g4rqST72reoHMM5a" } }}Show a State Version
GET /state-versions/:state_version_id
Viewing state versions requires permission to read state versions for the workspace. (More about permissions.)
| Parameter | Description |
|---|---|
:state_version_id | The ID of the desired state version. |
| Status | Response | Reason |
|---|---|---|
| 200 | JSON API document | Successfully returned current state version for the given workspace. |
| 404 | JSON API error object | Workspace not found, workspace does not have a current state version, or user unauthorized to perform action. |
Sample Request
curl \ --header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ https://app.terraform.io/api/v2/state-versions/sv-SDboVZC8TCxXEneJSample Response
{ "data": { "id": "sv-g4rqST72reoHMM5a", "type": "state-versions", "attributes": { "created-at": "2021-06-08T01:22:03.794Z", "size": 940, "hosted-state-download-url": "https://archivist.terraform.io/v1/object/...", "hosted-state-upload-url": null, "hosted-json-state-download-url": "https://archivist.terraform.io/v1/object/...", "hosted-json-state-upload-url": null, "status": "finalized", "intermediate": false, "modules": { "root": { "null-resource": 1, "data.terraform-remote-state": 1 } }, "providers": { "provider[\"terraform.io/builtin/terraform\"]": { "data.terraform-remote-state": 1 }, "provider[\"registry.terraform.io/hashicorp/null\"]": { "null-resource": 1 } }, "resources": [ { "name": "other_username", "type": "data.terraform_remote_state", "count": 1, "module": "root", "provider": "provider[\"terraform.io/builtin/terraform\"]" }, { "name": "random", "type": "null_resource", "count": 1, "module": "root", "provider": "provider[\"registry.terraform.io/hashicorp/null\"]" } ], "resources-processed": true, "serial": 9, "state-version": 4, "terraform-version": "0.15.4", "vcs-commit-url": "https://gitlab.com/my-organization/terraform-test/-/commit/abcdef12345", "vcs-commit-sha": "abcdef12345" }, "relationships": { "run": { "data": { "id": "run-YfmFLWpgTv31VZsP", "type": "runs" } }, "created-by": { "data": { "id": "user-onZs69ThPZjBK2wo", "type": "users" }, "links": { "self": "/api/v2/users/user-onZs69ThPZjBK2wo", "related": "/api/v2/runs/run-YfmFLWpgTv31VZsP/created-by" } }, "workspace": { "data": { "id": "ws-noZcaGXsac6aZSJR", "type": "workspaces" } }, "outputs": { "data": [ { "id": "wsout-V22qbeM92xb5mw9n", "type": "state-version-outputs" }, { "id": "wsout-ymkuRnrNFeU5wGpV", "type": "state-version-outputs" }, { "id": "wsout-v82BjkZnFEcscipg", "type": "state-version-outputs" } ] } }, "links": { "self": "/api/v2/state-versions/sv-g4rqST72reoHMM5a" } }}Rollback to a Previous State Version
PATCH /workspaces/:workspace_id/state-versions
| Parameter | Description |
|---|---|
:workspace_id | The workspace ID to create the new state version in. Obtain this from theworkspace settings or theShow Workspace endpoint. |
Creates a state version by duplicating the specified state version and sets it as the current state version for the given workspace. The workspace must be locked by the user creating a state version. The workspace may be lockedwith the API orwith the UI. This is most useful for rolling back to a known-good state after an operation such as a Terraform upgrade didn't go as planned.
Creating state versions requires permission to read and write state versions for the workspace. (More about permissions.)
Warning: Use caution when rolling back to a previous state. Replacing state improperly can result in orphaned or duplicated infrastructure resources.
Note: You cannot access this endpoint withorganization tokens. You must access it with auser token orteam token.
| Status | Response | Reason |
|---|---|---|
| 201 | JSON API document | Successfully rolled back. |
| 404 | JSON API error object | Workspace not found, or user unauthorized to perform action. |
| 409 | JSON API error object | Conflict; check the error object for more information. |
| 422 | JSON API error object | Malformed request body (missing attributes, wrong types, etc.). |
Request Body
This PATCH endpoint requires a JSON object with the following properties as a request payload.
Properties without a default value are required.
| Key path | Type | Default | Description |
|---|---|---|---|
data.type | string | Must be"state-versions". | |
data.relationships.rollback-state-version.data.id | string | The ID of the state version to use for the rollback operation. |
Sample Payload
{ "data": { "type":"state-versions", "relationships": { "rollback-state-version": { "data": { "type": "state-versions", "id": "sv-bWfq4Y1YpRKW4mx7" } } } }}Sample Request
curl \ --header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ --request PATCH \ --data @payload.json \ https://app.terraform.io/api/v2/workspaces/ws-6fHMCom98SDXSQUv/state-versionsSample Response
{ "data": { "id": "sv-DmoXecHePnNznaA4", "type": "state-versions", "attributes": { "created-at": "2022-11-22T01:22:03.794Z", "size": 940, "hosted-state-download-url": "https://archivist.terraform.io/v1/object/...", "hosted-state-upload-url": null, "hosted-json-state-download-url": "https://archivist.terraform.io/v1/object/...", "hosted-json-state-upload-url": null, "modules": { "root": { "null-resource": 1, "data.terraform-remote-state": 1 } }, "providers": { "provider[\"terraform.io/builtin/terraform\"]": { "data.terraform-remote-state": 1 }, "provider[\"registry.terraform.io/hashicorp/null\"]": { "null-resource": 1 } }, "resources": [ { "name": "other_username", "type": "data.terraform_remote_state", "count": 1, "module": "root", "provider": "provider[\"terraform.io/builtin/terraform\"]" }, { "name": "random", "type": "null_resource", "count": 1, "module": "root", "provider": "provider[\"registry.terraform.io/hashicorp/null\"]" } ], "resources-processed": true, "serial": 9, "state-version": 4, "terraform-version": "1.3.5" }, "relationships": { "rollback-state-version": { "data": { "id": "sv-YfmFLgTv31VZsP", "type": "state-versions" } } }, "links": { "self": "/api/v2/state-versions/sv-DmoXecHePnNznaA4" } }}Mark a State Version for Garbage Collection
This endpoint is exclusive to Terraform Enterprise, and not available in HCP Terraform.Learn more about Terraform Enterprise.
POST /api/v2/state-versions/:state_version_id/actions/soft_delete_backing_data
This endpoint directs Terraform Enterprise tosoft delete the backing files associated with this state version. Soft deletion marks the state version for garbage collection. Terraform permanently deletes state versions after a set number of days unless the state version is restored. Once a state version is soft deleted, any attempts to read the state version will fail. Refer toState Version Status for information about all data states.
This endpoint can only soft delete state versions that are in anfinalized state and are not the current state version. Otherwise, calling this endpoint results in an error.
You must have organization owner permissions to soft delete state versions. Refer toPermissions for additional information about permissions.
| Parameter | Description |
|---|---|
:state_version_id | The ID of the state version to mark for garbage collection. |
| Status | Response | Reason |
|---|---|---|
| 200 | JSON API document | Terraform successfully marked the data for garbage collection. |
| 400 | JSON API error object | Terraform failed to transition the state tobacking_data_soft_deleted. |
| 404 | JSON API error object | Terraform did not find the state version or the user is not authorized to modify the state version. |
Sample Request
curl \ --header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ --request POST \ https://app.terraform.io/api/v2/state-versions/sv-ntv3HbhJqvFzamy7/actions/soft_delete_backing_data --data {"data": {"attributes": {"delete-older-than-n-days": 23}}}Sample Response
{ "data": { "id": "sv-g4rqST72reoHMM5a", "type": "state-versions", "attributes": { "created-at": "2021-06-08T01:22:03.794Z", "size": 940, "hosted-state-download-url": "https://archivist.terraform.io/v1/object/...", "hosted-state-upload-url": null, "hosted-json-state-download-url": "https://archivist.terraform.io/v1/object/...", "hosted-json-state-upload-url": null, "status": "backing_data_soft_deleted", "intermediate": false, "delete-older-than-n-days": 23, "modules": { "root": { "null-resource": 1, "data.terraform-remote-state": 1 } }, "providers": { "provider[\"terraform.io/builtin/terraform\"]": { "data.terraform-remote-state": 1 }, "provider[\"registry.terraform.io/hashicorp/null\"]": { "null-resource": 1 } }, "resources": [ { "name": "other_username", "type": "data.terraform_remote_state", "count": 1, "module": "root", "provider": "provider[\"terraform.io/builtin/terraform\"]" }, { "name": "random", "type": "null_resource", "count": 1, "module": "root", "provider": "provider[\"registry.terraform.io/hashicorp/null\"]" } ], "resources-processed": true, "serial": 9, "state-version": 4, "terraform-version": "0.15.4", "vcs-commit-url": "https://gitlab.com/my-organization/terraform-test/-/commit/abcdef12345", "vcs-commit-sha": "abcdef12345" }, "relationships": { "run": { "data": { "id": "run-YfmFLWpgTv31VZsP", "type": "runs" } }, "created-by": { "data": { "id": "user-onZs69ThPZjBK2wo", "type": "users" }, "links": { "self": "/api/v2/users/user-onZs69ThPZjBK2wo", "related": "/api/v2/runs/run-YfmFLWpgTv31VZsP/created-by" } }, "workspace": { "data": { "id": "ws-noZcaGXsac6aZSJR", "type": "workspaces" } }, "outputs": { "data": [ { "id": "wsout-V22qbeM92xb5mw9n", "type": "state-version-outputs" }, { "id": "wsout-ymkuRnrNFeU5wGpV", "type": "state-version-outputs" }, { "id": "wsout-v82BjkZnFEcscipg", "type": "state-version-outputs" } ] } }, "links": { "self": "/api/v2/state-versions/sv-g4rqST72reoHMM5a" } }}Restore a State Version Marked for Garbage Collection
This endpoint is exclusive to Terraform Enterprise, and not available in HCP Terraform.Learn more about Terraform Enterprise.
POST /api/v2/state-versions/:state_version_id/actions/restore_backing_data
This endpoint directs Terraform Enterprise to restore backing files associated with this state version. This endpoint can only restore state versions that are not in abacking_data_permanently_deleted state. Terraform restores applicable state versions back to theirfinalized state. Otherwise, calling this endpoint results in an error.
You must have organization owner permissions to restore state versions. Refer toPermissions for additional information about permissions.
| Parameter | Description |
|---|---|
:state_version_id | The ID of the state version to restore. |
| Status | Response | Reason |
|---|---|---|
| 200 | JSON API document | Terraform successfully initiated the restore process. |
| 400 | JSON API error object | Terraform failed to transition the state tofinalized. |
| 404 | JSON API error object | Terraform did not find the state version or the user is not authorized to modify the state version. |
Sample Request
curl \ --header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ --request POST \ https://app.terraform.io/api/v2/state-versions/sv-ntv3HbhJqvFzamy7/actions/restore_backing_dataSample Response
{ "data": { "id": "sv-g4rqST72reoHMM5a", "type": "state-versions", "attributes": { "created-at": "2021-06-08T01:22:03.794Z", "size": 940, "hosted-state-download-url": "https://archivist.terraform.io/v1/object/...", "hosted-state-upload-url": null, "hosted-json-state-download-url": "https://archivist.terraform.io/v1/object/...", "hosted-json-state-upload-url": null, "status": "uploaded", "intermediate": false, "modules": { "root": { "null-resource": 1, "data.terraform-remote-state": 1 } }, "providers": { "provider[\"terraform.io/builtin/terraform\"]": { "data.terraform-remote-state": 1 }, "provider[\"registry.terraform.io/hashicorp/null\"]": { "null-resource": 1 } }, "resources": [ { "name": "other_username", "type": "data.terraform_remote_state", "count": 1, "module": "root", "provider": "provider[\"terraform.io/builtin/terraform\"]" }, { "name": "random", "type": "null_resource", "count": 1, "module": "root", "provider": "provider[\"registry.terraform.io/hashicorp/null\"]" } ], "resources-processed": true, "serial": 9, "state-version": 4, "terraform-version": "0.15.4", "vcs-commit-url": "https://gitlab.com/my-organization/terraform-test/-/commit/abcdef12345", "vcs-commit-sha": "abcdef12345" }, "relationships": { "run": { "data": { "id": "run-YfmFLWpgTv31VZsP", "type": "runs" } }, "created-by": { "data": { "id": "user-onZs69ThPZjBK2wo", "type": "users" }, "links": { "self": "/api/v2/users/user-onZs69ThPZjBK2wo", "related": "/api/v2/runs/run-YfmFLWpgTv31VZsP/created-by" } }, "workspace": { "data": { "id": "ws-noZcaGXsac6aZSJR", "type": "workspaces" } }, "outputs": { "data": [ { "id": "wsout-V22qbeM92xb5mw9n", "type": "state-version-outputs" }, { "id": "wsout-ymkuRnrNFeU5wGpV", "type": "state-version-outputs" }, { "id": "wsout-v82BjkZnFEcscipg", "type": "state-version-outputs" } ] } }, "links": { "self": "/api/v2/state-versions/sv-g4rqST72reoHMM5a" } }}Permanently Delete a State Version
This endpoint is exclusive to Terraform Enterprise, and not available in HCP Terraform.Learn more about Terraform Enterprise.
POST /api/v2/state-versions/:state_version_id/actions/permanently_delete_backing_data
This endpoint directs Terraform Enterprise to permanently delete backing files associated with this state version. This endpoint can only permanently delete state versions that are in anbacking_data_soft_deleted state and are not the current state version. Otherwise, calling this endpoint results in an error.
You must have organization owner permissions to permanently delete state versions. Refer toPermissions for additional information about permissions.
| Parameter | Description |
|---|---|
:state_version_id | The ID of the state version to permanently delete. |
| Status | Response | Reason |
|---|---|---|
| 200 | JSON API document | Terraform deleted the data permanently. |
| 400 | JSON API error object | Terraform failed to transition the state tobacking_data_permanently_deleted. |
| 404 | JSON API error object | Terraform did not find the state version or the user is not authorized to modify the state version data. |
Sample Request
curl \ --header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ --request POST \ https://app.terraform.io/api/v2/state-versions/sv-ntv3HbhJqvFzamy7/actions/permanently_delete_backing_dataSample Response
{ "data": { "id": "sv-g4rqST72reoHMM5a", "type": "state-versions", "attributes": { "created-at": "2021-06-08T01:22:03.794Z", "size": 940, "hosted-state-download-url": "https://archivist.terraform.io/v1/object/...", "hosted-state-upload-url": null, "hosted-json-state-download-url": "https://archivist.terraform.io/v1/object/...", "hosted-json-state-upload-url": null, "status": "backing_data_permanently_deleted", "intermediate": false, "modules": { "root": { "null-resource": 1, "data.terraform-remote-state": 1 } }, "providers": { "provider[\"terraform.io/builtin/terraform\"]": { "data.terraform-remote-state": 1 }, "provider[\"registry.terraform.io/hashicorp/null\"]": { "null-resource": 1 } }, "resources": [ { "name": "other_username", "type": "data.terraform_remote_state", "count": 1, "module": "root", "provider": "provider[\"terraform.io/builtin/terraform\"]" }, { "name": "random", "type": "null_resource", "count": 1, "module": "root", "provider": "provider[\"registry.terraform.io/hashicorp/null\"]" } ], "resources-processed": true, "serial": 9, "state-version": 4, "terraform-version": "0.15.4", "vcs-commit-url": "https://gitlab.com/my-organization/terraform-test/-/commit/abcdef12345", "vcs-commit-sha": "abcdef12345" }, "relationships": { "run": { "data": { "id": "run-YfmFLWpgTv31VZsP", "type": "runs" } }, "created-by": { "data": { "id": "user-onZs69ThPZjBK2wo", "type": "users" }, "links": { "self": "/api/v2/users/user-onZs69ThPZjBK2wo", "related": "/api/v2/runs/run-YfmFLWpgTv31VZsP/created-by" } }, "workspace": { "data": { "id": "ws-noZcaGXsac6aZSJR", "type": "workspaces" } }, "outputs": { "data": [ { "id": "wsout-V22qbeM92xb5mw9n", "type": "state-version-outputs" }, { "id": "wsout-ymkuRnrNFeU5wGpV", "type": "state-version-outputs" }, { "id": "wsout-v82BjkZnFEcscipg", "type": "state-version-outputs" } ] } }, "links": { "self": "/api/v2/state-versions/sv-g4rqST72reoHMM5a" } }}List State Version Outputs
The output values from a state version are also available via the API. For details, see thestate version outputs documentation.
Available Related Resources
The GET endpoints above can optionally return related resources, if requested withtheinclude query parameter. The following resource types are available:
created_by- The user that created the state version. For state versions created via a run executed by HCP Terraform, this is an internal user account.run- The run that created the state version, if applicable.run.created_by- The user that manually triggered the run, if applicable.run.configuration_version- The configuration version used in the run.outputs- The parsed outputs for this state version.