Update a workspace¶

Change the name of an existing workspace.

HTTP
PATCH $CLOUDSIGMA_API_BASE/workspaces/{id}

Before you call this API¶

Configure the regional API endpoint and authentication.

First list workspaces to confirm the workspace to update. You do not need to enter a workspace before calling this API.

Path parameter and request body¶

Replace $CLOUDSIGMA_API_KEY, $WORKSPACE_ID, and $WORKSPACE_NAME with actual values.

Input examples

Shell
curl -X PATCH "$CLOUDSIGMA_API_BASE/workspaces/$WORKSPACE_ID" \
  -H "X-API-Key: $CLOUDSIGMA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "'"$WORKSPACE_NAME"'"
  }'

Parameter details

Parameter	Type	Required	Description
`id`	string	Yes	ID of the workspace to update.
`name`	string	Yes	New workspace name. It cannot be empty.

Successful response¶

On success, the API returns 200, which indicates that the name was saved.

Response example

JSON
{
  "code": "OK",
  "msg": "OK"
}

Field details

Field	Type	Description
`code`	string	`OK` on success.
`msg`	string	`OK` on success.

Error response¶

Response example

JSON
{
  "code": "ErrParamInvalid",
  "msg": "Invalid request parameters",
  "data": null
}

Field details

Field	Type	Description
`code`	string	Error code.
`msg`	string	Human-readable error message.
`data`	null	`null` in an error response.

Next steps¶

List workspaces to confirm that the name was updated.

Last updated on Sep 15, 2026