unassign_variable_set_from_workspaces
Remove a variable set from specified Terraform Cloud workspaces to eliminate its variables from those environments. Requires varset_id and workspace_ids as inputs.
Instructions
Remove a variable set from one or more workspaces.
Removes the variable set assignment from the specified workspaces. The variables will no longer be available in those workspaces.
API endpoint: DELETE /varsets/{varset_id}/relationships/workspaces
Args: varset_id: The ID of the variable set (format: "varset-xxxxxxxx") workspace_ids: List of workspace IDs (format: ["ws-xxxxxxxx", ...])
Returns: Empty response with HTTP 204 status code if successful
See: docs/tools/variables.md#unassign-variable-set-from-workspaces for reference documentation
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| varset_id | Yes | ||
| workspace_ids | Yes |
Implementation Reference
- The handler function that executes the tool logic: unassigns the specified variable set from the given workspaces by constructing a DELETE request payload to the Terraform Cloud API endpoint /varsets/{varset_id}/relationships/workspaces.@handle_api_errors async def unassign_variable_set_from_workspaces( varset_id: str, workspace_ids: List[str] ) -> APIResponse: """Remove a variable set from one or more workspaces. Removes the variable set assignment from the specified workspaces. The variables will no longer be available in those workspaces. API endpoint: DELETE /varsets/{varset_id}/relationships/workspaces Args: varset_id: The ID of the variable set (format: "varset-xxxxxxxx") workspace_ids: List of workspace IDs (format: ["ws-xxxxxxxx", ...]) Returns: Empty response with HTTP 204 status code if successful See: docs/tools/variables.md#unassign-variable-set-from-workspaces for reference documentation """ # Build relationships payload relationships_data = [] for workspace_id in workspace_ids: relationships_data.append({"type": "workspaces", "id": workspace_id}) payload = {"data": relationships_data} endpoint = f"varsets/{varset_id}/relationships/workspaces" return await api_request(endpoint, method="DELETE", data=payload)
- terraform_cloud_mcp/server.py:137-137 (registration)Registers the 'unassign_variable_set_from_workspaces' tool with the MCP server using mcp.tool decorator configured for write operations.mcp.tool(**write_tool_config)(variables.unassign_variable_set_from_workspaces)