跳到主要内容
Docs/Api Reference/Api Keys

API Keys API

Manage tenant API keys.

Endpoints

MethodPathDescription
GET`/api/v1/api-keys`List (no secrets)
POST`/api/v1/api-keys`Create (returns secret once)
POST`/api/v1/api-keys/:id/rotate`Rotate (returns new secret once)
POST`/api/v1/api-keys/:id/toggle`Enable / disable
DELETE`/api/v1/api-keys/:id`Revoke

Note on JWT-only

This namespace requires a JWT (interactive user). API-key authentication is rejected — preventing a leaked key from minting replacements for itself.

Every response uses the standard envelope:

{
  "success": true,
  "data": { /* resource or array */ },
  "meta": { "total": 100, "cursor": "...", "hasMore": true },
  "error": { "code": "ERROR_CODE", "message": "Human readable" }
}

error is omitted on success; meta is omitted when not paginating.

Rate Limits

Subject to the standard 200 req/min/tenant authenticated limit. See [Rate Limits](/docs/api-reference/rate-limits) for full details and the per-endpoint overrides.

← Back to Docs