Update a database

Can be used by the following roles assigned at the organization, folder or cluster scope:

• CLUSTER_ADMIN
• CLUSTER_OPERATOR_WRITER

PATCH /api/v1/clusters/{cluster_id}/databases/{name}

cURL

cURL

curl --request PATCH \
  --url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/databases/{name} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "example_database_name",
  "new_name": "example_new_database_name"
}
'

200

{
  "name": "<string>",
  "table_count": "<string>"
}

{
  "code": 123,
  "details": [
    {
      "@type": "<string>"
    }
  ],
  "message": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

cluster_id · string · required

name · string · required

Body

application/json

name · string · required

new_name · string · required

Response

200

application/json

A successful response.

name · string · required

table_count · string<int64>