SIsigmacomputing
Workspaces

Update a workspace

This endpoint updates the name of an existing workspace identified by its workspaceId.

Usage notes

  • Set NoDuplicates to true to prevent the creation of a duplicate workspace.
  • Retrieve the workspaceId by calling the /v2/workspaces endpoint.

Usage scenarios

  • Configuration change: Allows users to update workspace settings or names as projects evolve or requirements change.
  • Access control adjustments: Update workspace details in response to organizational changes or policy updates.

Best practices

  • Partial updates: Use PATCH to support partial updates, only sending the fields that need to be updated.
  • Validation: Validate input data to ensure it adheres to expected formats and constraints. Handle errors gracefully and inform the user of any constraints.
patch/v2/workspaces/{workspaceId}

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Path parameters

workspaceIdstring required

Unique identifier of the workspace.

Request body

namestring required

Name of the new workspace.

noDuplicatesboolean

Set to true to avoid creating a workspace with a duplicate name.

Response

The response body.

workspaceIdstring required
workspaceUrlIdstring required

Base62-encoded identifier used in Sigma workspace URLs.

namestring required
createdBystring required
updatedBystring required
createdAtstring date-time required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.