Update a SQL user's password

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

• CLUSTER_ADMIN

PUT /api/v1/clusters/{cluster_id}/sql-users/{name}/password

cURL

cURL

curl --request PUT \
  --url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/sql-users/{name}/password \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --json '{"password":"example_new_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

name · string · required

Body

application/json

password · string · required

Response

200

application/json

A successful response.

name · string · required