POST
/
v1
/
api-keys
{
  "created_at": "2024-01-01T00:00:00",
  "expiration_date": "2024-12-31T23:59:59",
  "key_id": "507f1f77bcf86cd799439011",
  "name": "Development API Key",
  "permissions": [
    "read",
    "write"
  ],
  "revoked": false
}

Body

application/json
​
name
string
required

A descriptive name for the API key to help identify its purpose and usage context

​
expiration_days
integer
default:30

Number of days until the API key expires, between 1 and 365 days

Required range: 1 <= x <= 365
​
permissions
string[]

List of permission scopes granted to this API key, controlling what API endpoints it can access

Response

200
application/json
Successful Response
​
_id
string
required

Unique identifier for this API key in the database

​
name
string
required

The descriptive name given to this API key

​
permissions
string[]
required

List of permission scopes granted to this API key

​
expiration_date
string
required

Timestamp when this API key will expire and become invalid

​
created_at
string
required

Timestamp when this API key was created

​
created_by_user_id
string
required

Identifier of the user who created this API key

​
api_key
string
required

The actual API key value. This is only returned once when the key is created and cannot be retrieved later

​
revoked
boolean
default:false

Indicates if this API key has been manually revoked before its expiration date