Skip to main content
POST
/
api-keys
Create new API key
curl --request POST \
  --url http://localhost:4000/v1/api-keys \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "scopes": [
    "read",
    "write"
  ]
}
'

Authorizations

​
Authorization
string
header
required

Use this format: ApiKey <your_api_key>

Body

application/json
​
name
string
required

Name of the API Key

​
description
string
required

Description of the API key

​
scopes
enum<string>
required

Scopes for the API Key

Available options:
admin,
internal,
external,
integrator
Example:
["read", "write"]

Response

API key created