v44

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-20129390589.6 KB

Workspaces

Update workspace

⚠️ This endpoint is in public preview.

Rename a workspace.

patch/preview/v2/workspaces/{workspace}

Path parameters

workspacestring required

A resource path like 'sfc:workspace:acme:my-workspace' or an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent.

Example:wksp_k3R-nX9vLm7Qp2Yw5Jd8F

Workspace name or ID

Request body

namestring nullable

Response

Workspace updated.

idstring required

resource_pathstring required

A resource path for a workspace resource. Format: sfc:workspace:<account>:<name>.

ownerstring required

namestring required

object'workspace' required

created_atinteger required

Unix timestamp.

Example response

{
  "id": "wksp_k3R-nX9vLm7Qp2Yw5Jd8F",
  "resource_path": "sfc:workspace:<account_id>:<name>",
  "owner": "my-resource-name",
  "name": "my-resource-name",
  "object": "workspace",
  "created_at": 1738972800
}