Skip to main content
POST
Create Api Key

Authorizations

Authorization
string
header
required

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

Headers

authorization
string | null

Body

application/json

Request to create a new API key.

name
string | null

Optional name for the API key

Maximum string length: 255
Example:

"My CI/CD Pipeline"

scopes
string[]

Response

Successful Response

Response when creating a new API key (includes the full key).

created_at
string<date-time>
required
id
string<uuid>
required
key
string
required

The full API key. Save this - it won't be shown again!

key_prefix
string
required
name
string | null
required
scopes
string[]