Update folder¶

Update folder information; checking if name is a valid identifier when provided.

HTTP
POST $CLOUDSIGMA_API_BASE/catalog/folder/update

Before you call this API¶

Configure the regional API endpoint and authentication, and select the target workspace.

First query the file list to obtain the target folder ID.

Set the operation-specific values used in the request:

$FOLDER_ID: Folder ID to update.

The caller needs write access to the root volume.

Request¶

Input examples

Shell
curl -X POST "$CLOUDSIGMA_API_BASE/catalog/folder/update" \
  -H "X-API-Key: $CLOUDSIGMA_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "id": '"$FOLDER_ID"',
    "name": "<FOLDER_NAME>",
    "description": "<FOLDER_DESCRIPTION>"
  }'

Parameter reference

Request body

Parameter	Type	Required	Description
`id`	integer	Yes	Folder ID.
`name`	string	No	New name.
`description`	string	No	New description.

Successful response¶

Returns 200 on success, data is null. The caller needs write access to the root volume.

Response example

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

Field reference

The response fields are as follows.

Field	Type	Description
`code`	string	`OK` on success.
`msg`	string	`OK` on success.
`data`	null	Fixed to `null` when the update is successful.

Error response¶

Response example

JSON
{
  "code": "ErrParamInvalid",
  "msg": "name 无效",
  "data": null
}

Field reference

Common HTTP errors¶

HTTP status code	error code	Common causes	Recommended actions
`400`	`ErrParamInvalid`	The request format is invalid, or the supplied `name` is invalid.	Check folder ID and name.
`403`	`ErrForbidden`	The current identity does not have write permissions to the root volume.	Use credentials with write access, or contact your administrator for authorization.
`409`	`ErrReadonly`	The database where the folder is located is not writable.	Select a folder in a writable volume.
`500`	`ErrServer`	The service cannot update the folder.	Record the request time and error message and try again; if it continues to fail, contact support.

Follow-up operations¶

Use the same resource identifier Query Catalog details to confirm the update result.

Last updated on Sep 15, 2026