Delete database¶

Delete the specified database. This operation is irreversible; please confirm that the database and the data in it are no longer needed before performing it.

HTTP
POST $CLOUDSIGMA_API_BASE/meta/db/drop

Before you call this API¶

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

You can first query database to confirm the name.

Request¶

Replace caller-specific values in the example with actual values.

Input examples

Shell
curl -X POST "$CLOUDSIGMA_API_BASE/meta/db/drop" \
  -H "X-API-Key: $CLOUDSIGMA_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d "{\"db_name\":\"$DATABASE\"}"

Parameter reference

Request body

Parameter	Type	Required	Description
`db_name`	string	Required	The name of the database to be deleted.

Successful response¶

Response example

JSON
{"code":200,"data":null}

Field reference

The response fields are as follows.

Field	Type	Description
`code`	integer	`200` on success.
`data`	null	This operation does not return a result object.

A successful response does not return an object. Then query the database to confirm that the database no longer appears.

Error response¶

Response example

JSON
{
  "code": 400,
  "message": "db_name 不能为空"
}

Field reference

Field	Type	Description
`code`	integer or string	Error code or status.
`message`	string	Error message.

Follow-up operations¶

View table field, confirm that the target no longer appears.

Last updated on Sep 15, 2026