Create an API key

POST/api-keys

Requires an API key with one of these roles: admin.

Authorization

bearerAuth

AuthorizationBearer <token>

An API key created in Settings → API Keys.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length <= 100

role*string

Value in

"admin"
"editor"
"viewer"

expiresAt?string

Match

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$

Formatdate-time

rateLimit?integer

Range0 < value <= 9007199254740991

Response Body

`application/json`

curl -X POST "https://example.com/api-keys" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "role": "admin"  }'

{  "data": {    "key": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "role": "admin",      "keyPrefix": "string",      "status": "active",      "expiresAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "lastUsedAt": "2019-08-24T14:15:22Z",      "requestCount": 0,      "rateLimit": 0    },    "plaintext": "string"  },  "meta": {    "requestId": "string",    "timestamp": "string"  }}

Create an API key

Authorization

Request Body

Response Body

201application/json

401application/json

403application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`