workspaces

Update a Workspace

Update the specified Workspace.

patch/v1/organizations/{organizationId}/workspaces/{workspaceId}

Path parameters

organizationIdstring required

The <code>id</code> of the Organization that contains the Workspace.

workspaceIdstring required

The <code>id</code> of the Workspace to update.

Request body

aliasstring

User-friendly alias for the Workspace.

descriptionstring

Brief description of the Workspace.

tagsstring[]

Tags associated with the Workspace.

Example request

{
  "alias": "Production Environment",
  "description": "Main production Workspace for customer data processing",
  "tags": [
    "production",
    "customer-data"
  ]
}

Response

The Workspace has been successfully updated

Changes

Changed in 7 of the 41 revisions of this API.11018

Mar 4, 2026bfa460b2aec33See the full diff
- ●
  the alias request property's maxLength was set to 30
  request-property-max-length-set
- ●
  the description request property's maxLength was set to 255
  request-property-max-length-set
- ●
  the tags/items/ request property's maxLength was set to 30
  request-property-max-length-set
Oct 10, 20250d907f2a36961See the full diff
- ○
  removed the non-success response with the status 500
  response-non-success-status-removed
Oct 9, 2025a6fde5be66ad11See the full diff
- ▲
  removed the success response with the status 200
  response-success-status-removed
- ○
  added the success response with the status 204
  response-success-status-added
Oct 8, 202500753fc6a7b0513See the full diff
- ●
  added the new Active enum value to the state/allOf[WorkspaceState]/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new Deprovisioning enum value to the state/allOf[WorkspaceState]/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new Failed enum value to the state/allOf[WorkspaceState]/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new Inactive enum value to the state/allOf[WorkspaceState]/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new Provisioning enum value to the state/allOf[WorkspaceState]/ response property for the response status 200
  response-property-enum-value-added
- ○
  removed the Workspace-Active enum value from the state/allOf[WorkspaceState]/ response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the Workspace-Cleanup-Completed enum value from the state/allOf[WorkspaceState]/ response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the Workspace-Cleanup-Failed enum value from the state/allOf[WorkspaceState]/ response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the Workspace-Cleanup-Requested enum value from the state/allOf[WorkspaceState]/ response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the Workspace-Cleanup-Started enum value from the state/allOf[WorkspaceState]/ response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the Workspace-Cleanup-Terraform-Completed enum value from the state/allOf[WorkspaceState]/ response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the Workspace-Cleanup-Terraform-Failed enum value from the state/allOf[WorkspaceState]/ response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the Workspace-Failed-Update enum value from the state/allOf[WorkspaceState]/ response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the Workspace-Provisioned enum value from the state/allOf[WorkspaceState]/ response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the Workspace-Provisioning enum value from the state/allOf[WorkspaceState]/ response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the Workspace-Provisioning-Failed enum value from the state/allOf[WorkspaceState]/ response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the Workspace-Requested enum value from the state/allOf[WorkspaceState]/ response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the Workspace-Updated enum value from the state/allOf[WorkspaceState]/ response property for the response status 200
  response-property-enum-value-removed
Sep 30, 2025db7f7dd086ea2See the full diff
- ●
  added the new ap-southeast-1 enum value to the region/allOf[AWSRegions]/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new eu-central-2 enum value to the region/allOf[AWSRegions]/ response property for the response status 200
  response-property-enum-value-added
Aug 13, 2025bc63c2cca59c2See the full diff
- ○
  the endpoint scheme security bearer was removed from the API
  api-security-removed
- ○
  the endpoint scheme security oauth2 was removed from the API
  api-security-removed
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 7, 2025914a71ae4db31See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history