Update an API Key

Can be used by the following roles assigned at the organization scope:

• ORG_ADMIN

PATCH /api/v1/api-keys/{id}

cURL

cURL

curl --request PATCH \
  --url https://cockroachlabs.cloud/api/v1/api-keys/{id} \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --json '{"name":"new name"}'

200

{
  "created_at": "2022-03-22T20:23:11.285067Z",
  "id": "CCDB1_12345abcdefGHIJKLMnopq",
  "name": "example name",
  "service_account_id": "1234abcd-1234-1234-abcd-12345678abcd"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string · required

The ID of the api key.

Body

application/json

The new name for the api key. Required.

name · string

The new name of the api key. Required; must not be empty.

Example:

"new name"

Response

200

application/json

A successful response.

created_at · string<date-time> · required

the creation time of the api key.

Example:

"2022-03-22T20:23:11.285067Z"

id · string · required

the ID of the api key.

Example:

"CCDB1_12345abcdefGHIJKLMnopq"

name · string · required

Example:

"api key name"

service_account_id · string<uuid> · required

the ID of the service account the api key references.

Example:

"1234abcd-1234-1234-abcd-12345678abcd"