AimableDocs
DocsAPI ReferenceRelease Notes
POST/v1/admin/principals/{principal_id}/api-keys

Create Admin Api Key

Path Parameters

NameTypeRequiredDescription
principal_idstring (uuid)Required

Headers

NameTypeRequiredDescription
X-API-KeystringOptional

Request Body

application/jsonRequired
namestringRequired
scopesstring[]
expires_atobject
Authentication
X-API-Key: ak.<key_id>.<secret>Authentication & errors →

Request

curl -X POST '/api/v1/admin/principals/{principal_id}/api-keys' \
  -H 'X-API-Key: ak.<key_id>.<secret>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "scopes": [
    "string"
  ],
  "expires_at": {}
}'

Response

201

No response body documented

Error Responses