Terraform Cloud icon

Terraform Cloud

Interact with the Terraform Cloud API

Workspace → Update Workspace

AI-generated

Summary

Update workspace settings by workspace ID to change its configuration in Terraform Cloud.

Inputs

  • Workspace ID (required) — ID of the workspace to update (not the workspace name).
  • Update Name — New slug name for the workspace.
  • Options — Collection of optional workspace settings to update including description, auto apply flags, terraform version, execution mode, VCS repo configuration, tags, project attachment, variables, and more.

Output shape

a single object containing the updated workspace details as returned from the Terraform Cloud API

Requires workspace ID; updating execution mode to agent requires specifying an agent pool ID. If no fields or relationships are provided to update, the operation throws an error. Variables cannot be updated with this operation (only on create). Errors include details from the API if present.

Examples

Example 1: Update a workspace's name and description by workspace ID

Provide Workspace ID, set 'Update Name' and 'Options.description' to new values.

Example 2: Change VCS repository settings and tags for a workspace

Provide Workspace ID and within Options, specify 'vcsRepo' settings including identifier and auth type, and set 'tagNames' with comma-separated tag strings.

Links

Discussion