Create a new SQL user

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

• CLUSTER_ADMIN

POST /api/v1/clusters/{cluster_id}/sql-users

cURL

cURL

curl --request POST \
  --url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/sql-users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "example_username",
  "password": "example_password"
}
'

200

{
  "name": "<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

Body

application/json

name · string · required

password · string · required

Response

200

application/json

A successful response.

name · string · required