Skip to main content
POST
/
v1
/
api-keys
Create an API key
curl --request POST \
  --url http://localhost:3001/v1/api-keys \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "scopes": [],
  "expiresAt": "2023-11-07T05:31:56Z"
}
'
{
  "id": "<string>",
  "organizationId": "<string>",
  "name": "<string>",
  "prefix": "<string>",
  "scopes": [
    "<string>"
  ],
  "createdByUserId": "<string>",
  "lastUsedAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "revokedAt": "2023-11-07T05:31:56Z",
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "plaintextKey": "<string>"
}

Headers

​
authorization
string
Minimum string length: 1
​
x-organization-id
string
Minimum string length: 1

Body

application/json
​
name
string
required
Required string length: 1 - 120
​
scopes
string[]
required
Maximum array length: 50
Minimum string length: 1
​
expiresAt
string<date-time> | null
Pattern: ^(?:(?:\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))$

Response

Default Response

​
id
string
required
​
organizationId
string
required
​
name
string
required
​
prefix
string
required
​
scopes
string[]
required
​
createdByUserId
null | string
required
​
lastUsedAt
null | string<date-time>
required
​
expiresAt
null | string<date-time>
required
​
revokedAt
null | string<date-time>
required
​
status
enum<string>
required
Available options:
active,
expired,
revoked
​
metadata
object
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
plaintextKey
string
required