Skip to main content
POST
/
api
/
v1
/
api-keys
Create Api Key
curl --request POST \
  --url https://api.example.com/api/v1/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "key": "<string>",
  "name": "<string>",
  "key_prefix": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Request to create a new API key.

​
name
string
required

User-defined label for the key

Required string length: 1 - 100

Response

Successful Response

Response after creating an API key. Raw key is shown only once.

​
id
string<uuid>
required
​
key
string
required

Full API key (shown only once)

​
name
string
required
​
key_prefix
string
required

First 17 chars for identification

​
created_at
string<date-time>
required