Skip to main content

Create API Key

POST /api-keys

Description

Create a new API key for machine-to-machine authentication.

Authentication

Bearer Token

Request

Headers

HeaderValueRequired
AuthorizationBearer {{token}}Yes
Content-Typeapplication/jsonYes

Request Body

{
"name": "Test Client",
"description": "Test Client",
"scopes": ["*"],
"rateLimitPerHour": 3600,
"expiresAt": "2027-04-28T10:30:00.000"
}
FieldTypeRequiredDescription
namestringYesAPI key name
descriptionstringNoDescription of the API key
scopesarray of stringsYesPermission scopes (e.g., ["*"] for all)
rateLimitPerHournumberYesRate limit per hour
expiresAtstring (ISO 8601)YesExpiration date