--- updatedAt: 2026-05-05T11:11:03.000Z agentTools: projectIndex: https://docs.scalr.io/llms.txt --- # List variable set variables Returns a list of variable set variables. # OpenAPI definition ```json { "components": { "schemas": { "VariableSetVariable": { "description": "A Variable describes the configuration and value of a variable in a variable set.\nThere are \"terraform\" and \"shell\" variables.\n\n* Terraform variables define values to be passed into the corresponding Terraform input variable\n that is defined in the Configuration Version to be used in a run. Scalr Terraform variables\n are added to the `terraform.tfvars.json` file in the working directory of the workspace\n prior to any run. The values passed in can be HCL structures if the `hcl` attribute is `true`.\n* Shell variables define environment variables that are added to the runtime environment\n of a workspace using `export VAR=value`. These variables can pass authentication parameters\n to providers or any data required for local processing, such as via `local-exec` provisioners.", "properties": { "attributes": { "properties": { "category": { "description": "* `terraform` - values to be passed to terraform input variables of the same name.\n* `shell` - environment variables. They will be injected via `export` during a terraform run.", "enum": [ "terraform", "shell" ], "type": "string" }, "description": { "description": "Variable description.", "maxLength": 512, "nullable": true, "type": "string" }, "final": { "default": false, "description": "Indicates whether the variable can be overridden on a lower scope\ndown the Scalr organizational model.", "type": "boolean" }, "hcl": { "default": false, "description": "Indicates whether the value of the variable is a string of HCL code.\nNot applicable to `shell` category variables.", "type": "boolean" }, "key": { "description": "Variable name. Must correspond to the name of a Terraform input variable\nin the configuration if category is terraform.", "maxLength": 128, "type": "string" }, "sensitive": { "default": false, "description": "Indicates whether the value is sensitive. When set to `true`,\nthen the variable value is not visible after being written.", "type": "boolean" }, "updated-at": { "description": "The UTC timestamp of the last update to this variable.", "format": "date-time", "readOnly": true, "type": "string" }, "updated-by-email": { "description": "The email of the user who last updated this variable.", "nullable": true, "readOnly": true, "type": "string" }, "value": { "default": "", "description": "Variable value. Not visible if `sensitive: true` is enabled", "maxLength": 65535, "nullable": true, "type": "string" } }, "required": [ "key", "category" ], "type": "object" }, "id": { "readOnly": true, "type": "string" }, "links": { "properties": { "self": { "readOnly": true, "type": "string" } }, "readOnly": true, "type": "object" }, "relationships": { "properties": { "account": { "description": "The account this variable belongs to.", "properties": { "data": { "nullable": true, "properties": { "id": { "type": "string" }, "type": { "enum": [ "accounts", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "readOnly": true, "required": [ "data" ], "type": "object" }, "var-set": { "description": "The variable set this variable belongs to.", "properties": { "data": { "properties": { "id": { "type": "string" }, "type": { "enum": [ "var-sets", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "required": [ "data" ], "type": "object" } }, "required": [ "var-set" ], "type": "object" }, "type": { "enum": [ "var-set-variables" ], "type": "string" } }, "required": [ "type", "attributes", "relationships" ], "type": "object" }, "VariableSetVariableListingDocument": { "description": "JSON:API Document Listing\n\nsee: https://jsonapi.org/format/#document-structure", "properties": { "data": { "items": { "$ref": "#/components/schemas/VariableSetVariable" }, "type": "array" }, "included": { "items": { "type": "object" }, "readOnly": true, "type": "array" }, "links": { "additionalProperties": { "type": "string" }, "readOnly": true, "type": "object" }, "meta": { "readOnly": true, "type": "object" } }, "type": "object" } }, "securitySchemes": { "API-Key": { "scheme": "bearer", "type": "http" } } }, "info": { "description": "Scalr IACP API", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0" }, "title": "Scalr IACP API", "version": "unversioned" }, "openapi": "3.0.0", "paths": { "/var-set-variables": { "get": { "description": "Returns a list of variable set variables.\n", "operationId": "list_var_set_variables", "parameters": [ { "description": "Filter by variable key.", "in": "query", "name": "filter[key]", "required": false, "schema": { "type": "string" } }, { "description": "Filter by variable category.", "in": "query", "name": "filter[category]", "required": false, "schema": { "type": "string" } }, { "description": "Filter by variable ID(s).", "in": "query", "name": "filter[var-set-variable]", "required": false, "schema": { "type": "string" } }, { "description": "Filter by variable set ID(s).", "in": "query", "name": "filter[var-set]", "required": false, "schema": { "type": "string" } }, { "description": "Page number.", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "string" } }, { "description": "Page size.", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "string" } }, { "description": "The comma-separated list of attributes.", "explode": false, "in": "query", "name": "sort", "required": false, "schema": { "items": { "enum": [ "key", "updated-at" ], "type": "string" }, "type": "array" } }, { "description": "The comma-separated list of relationship paths.", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "var-set" ], "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/VariableSetVariableListingDocument" } } }, "description": "Success." }, "403": { "description": "User unauthorized to perform action." }, "4XX": { "description": "Client error." }, "5XX": { "description": "Server error." } }, "summary": "List variable set variables", "tags": [ "var-set-variables" ], "x-resource": "VariableSetVariable", "x-service": "tf-api" } } }, "security": [ { "API-Key": [] } ], "servers": [ { "url": "https://{Domain}/api/iacp/v3", "variables": { "Domain": { "default": "example.scalr.io", "description": "Domain where Scalr is hosted" } } } ] } ``` # Sibling pages * [Create a variable set variable](https://docs.scalr.io/scalr/reference/create_var_set_variable.md) * [Delete a variable set variable](https://docs.scalr.io/scalr/reference/delete_var_set_variable.md) * [Get a variable set variable](https://docs.scalr.io/scalr/reference/get_var_set_variable.md) * [Update a variable set variable](https://docs.scalr.io/scalr/reference/update_var_set_variable.md)