Skip to main content
POST
Create an API key

Authorizations

X-API-Key
string
header
required

Body

name
string
required
Required string length: 1 - 255
scopes
enum<string>[]
  • read - read
  • write - write
  • admin - admin
Available options:
read,
write,
admin
rate_limit
integer
default:1000

Requests per hour, from 1 to 100,000. A value outside that range is refused with a 400 that names rate_limit.

Required range: 1 <= x <= 100000
expires_at
string<date-time> | null
environment
string<uuid> | null
organization
string<uuid>

Response

201 - application/json
api_key
object
required
raw_key
string
required

The raw API key - save this, it will not be shown again