/api-key/create

Create a new API key for a user

Authorization

bearerAuth

AuthorizationBearer <token>

Bearer token authentication

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?|

Name of the Api Key

expiresIn*string

userId?|

User Id of the user that the Api Key belongs to. server-only. Eg: "user-id"

prefix?string|null

remaining*string

metadata?string|null

refillAmount?number|null

refillInterval?|

Interval to refill the Api Key in milliseconds. server-only. Eg: 1000

rateLimitTimeWindow?|

The duration in milliseconds where each request is counted. Once the maxRequests is reached, the request will be rejected until the timeWindow has passed, at which point the timeWindow will be reset. server-only. Eg: 1000

rateLimitMax?|

Maximum amount of requests allowed within a window. Once the maxRequests is reached, the request will be rejected until the timeWindow has passed, at which point the timeWindow will be reset. server-only. Eg: 100

rateLimitEnabled?|

Whether the key has rate limiting enabled. server-only. Eg: true

permissions?|

Permissions of the Api Key.

Response Body

`application/json`

curl -X POST "https://example.com/api-key/create" \  -H "Content-Type: application/json" \  -d '{    "expiresIn": "string",    "remaining": "string"  }'

{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "prefix": "string",  "start": "string",  "key": "string",  "enabled": true,  "expiresAt": "2019-08-24T14:15:22Z",  "userId": "string",  "lastRefillAt": "2019-08-24T14:15:22Z",  "lastRequest": "2019-08-24T14:15:22Z",  "metadata": {},  "rateLimitMax": 0,  "rateLimitTimeWindow": 0,  "remaining": 0,  "refillAmount": 0,  "refillInterval": 0,  "rateLimitEnabled": true,  "requestCount": 0,  "permissions": {    "property1": [      "string"    ],    "property2": [      "string"    ]  }}

{  "message": "string"}

{  "message": "string"}

{  "message": "string"}

{  "message": "string"}

{  "message": "string"}

{  "message": "string"}

/api-key/create

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`