Movatterモバイル変換

[0]ホーム
URL:

HashiConf 2025Don't miss the live stream of HashiConf Day 2 happening now View live stream

You are viewing documentation for version v202411-1.View latest version.

Important: The Variables API isdeprecated and will be removed in a future release. All existing integrations with this API should transition to theWorkspace Variables API.

This set of APIs covers create, update, list and delete operations on variables.

Create a Variable

POST /vars

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 pathTypeDefaultDescription
data.typestringMust be"vars".
data.attributes.keystringThe name of the variable.
data.attributes.valuestring""The value of the variable.
data.attributes.descriptionstringThe description of the variable.
data.attributes.categorystringWhether this is a Terraform or environment variable. Valid values are"terraform" or"env".
data.attributes.hclboolfalseWhether to evaluate the value of the variable as a string of HCL code. Has no effect for environment variables.
data.attributes.sensitiveboolfalseWhether the value is sensitive. If true then the variable is written once and not visible thereafter.
data.relationships.workspace.data.typestringMust be"workspaces".
data.relationships.workspace.data.idstringThe ID of the workspace that owns the variable. Obtain workspace IDs from theworkspace settings or theShow Workspace endpoint.

Deprecation warning: The customfilter properties are replaced by JSON APIrelationships and will be removed from future versions of the API!

Key pathTypeDefaultDescription
filter.workspace.namestringThe name of the workspace that owns the variable.
filter.organization.namestringThe name of the organization that owns the workspace.

Sample Payload

{  "data": {    "type":"vars",    "attributes": {      "key":"some_key",      "value":"some_value",      "description":"some description",      "category":"terraform",      "hcl":false,      "sensitive":false    },    "relationships": {      "workspace": {        "data": {          "id":"ws-4j8p6jX1w33MiDC7",          "type":"workspaces"        }      }    }  }}

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/vars

Sample Response

{  "data": {    "id":"var-EavQ1LztoRTQHSNT",    "type":"vars",    "attributes": {      "key":"some_key",      "value":"some_value",      "description":"some description",      "sensitive":false,      "category":"terraform",      "hcl":false    },    "relationships": {      "configurable": {        "data": {          "id":"ws-4j8p6jX1w33MiDC7",          "type":"workspaces"        },        "links": {          "related":"/api/v2/organizations/my-organization/workspaces/my-workspace"        }      }    },    "links": {      "self":"/api/v2/vars/var-EavQ1LztoRTQHSNT"    }  }}

List Variables

GET /vars

Query Parameters

These are standard URL query parameters. Remember to percent-encode[ as%5B and] as%5D if your tooling doesn't automatically encode URLs.

ParameterDescription
filter[workspace][name]Optional The name of one workspace to list variables for. If included, you must also include the organization name filter.
filter[organization][name]Optional The name of the organization that owns the desired workspace. If included, you must also included the workspace name filter.

These two parameters are optional but linked; if you include one, you must include both. Without a filter, this method lists variables for all workspaces where you have permission to read variables. (More about permissions.)

Sample Request

$ curl \  --header "Authorization: Bearer $TOKEN" \  --header "Content-Type: application/vnd.api+json" \"https://app.terraform.io/api/v2/vars?filter%5Borganization%5D%5Bname%5D=my-organization&filter%5Bworkspace%5D%5Bname%5D=my-workspace"# ?filter[organization][name]=my-organization&filter[workspace][name]=demo01

Sample Response

{  "data": [    {      "id":"var-AD4pibb9nxo1468E",      "type":"vars","attributes": {        "key":"name",        "value":"hello",        "description":"some description",        "sensitive":false,        "category":"terraform",        "hcl":false      },      "relationships": {        "configurable": {          "data": {            "id":"ws-cZE9LERN3rGPRAmH",            "type":"workspaces"          },          "links": {            "related":"/api/v2/organizations/my-organization/workspaces/my-workspace"          }        }      },      "links": {        "self":"/api/v2/vars/var-AD4pibb9nxo1468E"      }    }  ]}

Update Variables

PATCH /vars/:variable_id

ParameterDescription
:variable_idThe ID of the variable to be updated.

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 pathTypeDefaultDescription
data.typestringMust be"vars".
data.idstringThe ID of the variable to update.
data.attributesobjectNew attributes for the variable. This object can includekey,value,description,category,hcl, andsensitive properties, which are described above undercreate a variable. All of these properties are optional; if omitted, a property will be left unchanged.

Sample Payload

{  "data": {    "id":"var-yRmifb4PJj7cLkMG",    "attributes": {      "key":"name",      "value":"mars",      "description": "new description",      "category":"terraform",      "hcl": false,      "sensitive": false    },    "type":"vars"  }}

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/vars/var-yRmifb4PJj7cLkMG

Sample Response

{  "data": {    "id":"var-yRmifb4PJj7cLkMG",    "type":"vars",    "attributes": {      "key":"name",      "value":"mars",      "description":"new description",      "sensitive":false,      "category":"terraform",      "hcl":false    },    "relationships": {      "configurable": {        "data": {          "id":"ws-4j8p6jX1w33MiDC7",          "type":"workspaces"        },        "links": {          "related":"/api/v2/organizations/workspace-v2-06/workspaces/workspace-v2-06"        }      }    },    "links": {      "self":"/api/v2/vars/var-yRmifb4PJj7cLkMG"    }  }}

Delete Variables

DELETE /vars/:variable_id

ParameterDescription
:variable_idThe ID of the variable to be deleted.

Sample Request

$ curl \  --header "Authorization: Bearer $TOKEN" \  --header "Content-Type: application/vnd.api+json" \  --request DELETE \  https://app.terraform.io/api/v2/vars/var-yRmifb4PJj7cLkMG
Edit this page on GitHub
[8]ページ先頭
©2009-2025 Movatter.jp