update_variable_set
Modify Terraform Cloud variable sets by updating specific attributes such as name, description, global scope, or priority. Use this tool to tailor variable configurations without altering unspecified settings.
Instructions
Update an existing variable set.
Modifies the settings of a variable set. Only specified attributes will be updated; unspecified attributes remain unchanged.
API endpoint: PATCH /varsets/{varset_id}
Args: varset_id: The ID of the variable set (format: "varset-xxxxxxxx")
params: Variable set parameters to update (optional):
- name: New name for the variable set
- description: New description of the variable set
- global: Whether this is a global variable set
- priority: Whether this variable set takes priority over workspace variables
Returns: The updated variable set with all current settings and configuration
See: docs/tools/variables.md#update-variable-set for reference documentation
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| params | No | ||
| varset_id | Yes |
Input Schema (JSON Schema)
{
"$defs": {
"VariableSetParams": {
"description": "Parameters for variable set operations without routing fields.\n\nThis model provides all optional parameters for creating or updating variable\nsets, separating configuration parameters from routing information.\n\nReference: https://developer.hashicorp.com/terraform/cloud-docs/api-docs/variable-sets\n\nSee:\n docs/models/variables.md for reference",
"properties": {
"description": {
"anyOf": [
{
"maxLength": 512,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Description of the variable set",
"title": "Description"
},
"global": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Whether this is a global variable set",
"title": "Global"
},
"name": {
"anyOf": [
{
"maxLength": 90,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Variable set name",
"title": "Name"
},
"priority": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Whether this variable set takes priority over workspace variables",
"title": "Priority"
}
},
"title": "VariableSetParams",
"type": "object"
}
},
"properties": {
"params": {
"anyOf": [
{
"$ref": "#/$defs/VariableSetParams"
},
{
"type": "null"
}
],
"default": null,
"title": "Params"
},
"varset_id": {
"title": "Varset Id",
"type": "string"
}
},
"required": [
"varset_id"
],
"type": "object"
}