DokuBrain
API Reference

API Keys

API key management

List API keys

GET
/api-keys

Authorization

AuthorizationRequiredBearer <token>

Use a JWT access token or API key. Include as: Authorization: Bearer <token>

In: header

Query Parameters

limitinteger
Default: 50Maximum: 100
offsetinteger
Default: 0
curl -X GET "https://api.dokubrain.com/api/v1/api-keys?limit=50&offset=0" \
  -H "Authorization: Bearer <token>"

API keys (secrets masked)

{
  "success": true,
  "data": {},
  "message": "string"
}

Create an API key

The full API key is only returned once at creation. Store it securely.

POST
/api-keys

Authorization

AuthorizationRequiredBearer <token>

Use a JWT access token or API key. Include as: Authorization: Bearer <token>

In: header

Request Body

application/jsonRequired
nameRequiredstring
rate_limit_per_minuteinteger
rate_limit_per_dayinteger
expires_in_daysinteger
allowed_ipsarray<string>
allowed_endpointsarray<string>
metadataobject
curl -X POST "https://api.dokubrain.com/api/v1/api-keys" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "rate_limit_per_minute": 0,
    "rate_limit_per_day": 0,
    "expires_in_days": 0,
    "allowed_ips": [
      "string"
    ],
    "allowed_endpoints": [
      "string"
    ],
    "metadata": {}
  }'

API key created (includes one-time secret)

{
  "success": true,
  "data": {},
  "message": "string"
}

Get API key details

GET
/api-keys/{api_key_id}

Authorization

AuthorizationRequiredBearer <token>

Use a JWT access token or API key. Include as: Authorization: Bearer <token>

In: header

Path Parameters

api_key_idRequiredstring
curl -X GET "https://api.dokubrain.com/api/v1/api-keys/<string>" \
  -H "Authorization: Bearer <token>"

API key metadata

{
  "success": true,
  "data": {},
  "message": "string"
}

Revoke an API key

DELETE
/api-keys/{api_key_id}

Authorization

AuthorizationRequiredBearer <token>

Use a JWT access token or API key. Include as: Authorization: Bearer <token>

In: header

Path Parameters

api_key_idRequiredstring
curl -X DELETE "https://api.dokubrain.com/api/v1/api-keys/<string>" \
  -H "Authorization: Bearer <token>"

API key revoked

{
  "success": true,
  "data": {},
  "message": "string"
}

Update an API key

PUT
/api-keys/{api_key_id}

Authorization

AuthorizationRequiredBearer <token>

Use a JWT access token or API key. Include as: Authorization: Bearer <token>

In: header

Request Body

application/jsonOptional
namestring
is_activeboolean
rate_limit_per_minuteinteger
rate_limit_per_dayinteger
allowed_ipsarray<string>

Path Parameters

api_key_idRequiredstring
curl -X PUT "https://api.dokubrain.com/api/v1/api-keys/<string>" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "is_active": true,
    "rate_limit_per_minute": 0,
    "rate_limit_per_day": 0,
    "allowed_ips": [
      "string"
    ]
  }'

API key updated

{
  "success": true,
  "data": {},
  "message": "string"
}

Previous

Reports

Next

Governance