Create a new API Key - CockroachDB

curl --request POST \ --url https://cockroachlabs.cloud/api/v1/api-keys \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "example name", "service_account_id": "1234abcd-1234-1234-abcd-12345678abcd" } '

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

Authorizations

Authorization

string

header

required

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

Body

application/json

name

string

required

The name of the api key.

Example:

"example name"

service_account_id

string<uuid>

required

The ID of the service account to create the api key for.

Example:

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

Response

A successful response.

api_key

object

required

Show child attributes

Example:

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

secret

string<password>

required

The full api key. This is the value that would be passed in the Authorization header. It is not stored by the backend and is therefore not recoverable if lost.

Example:

"CCDB1_12345abcdefGHIJKLMnopq_NkdXLI9d81Mnx3djs45iwPfgtnaRv0XCh0Z9047K"