Skip to navigation

Update workspace

View as MarkdownOpen in Claude

Update a workspace’s description and/or limits.

Setting limits requires the Admin role on the workspace. Omitted fields are unchanged.

Example:

PUT /apis/entities/v2/workspaces/ml-team
{
"description": "Updated description for ML Team",
"limits": {"max_concurrent_jobs": 50}
}

Path parameters

namestringRequired

Request

This endpoint expects an object.
descriptionstringOptional
Updated description
limitsobjectOptional

Updated per-workspace limits. Omit to leave unchanged; requires workspace Admin.

Response

Successful Response
idstring

System-generated UUID

namestring

Workspace name (user-provided)

created_atdatetime
Timestamp of workspace creation
updated_atdatetime
Timestamp of last workspace update
descriptionstringOptional
Optional description
limitsobjectOptional

Optional per-workspace resource limits

created_bystringOptional
Principal id for workspace creator
updated_bystringOptional
Principal id for last workspace update

Errors

404
Not Found Error
422
Unprocessable Entity Error