IntegrationApiKey
/api/v1/integration/api-keysAn API key issued to an Application.
listgetcreaterevokeSchema
| Field | Type | Notes |
|---|---|---|
| id* | uuid | Server-assigned ULID with type prefix (e.g. per_…). |
| tenant_id* | string | Tenant scope — auto-stamped from the caller's JWT. |
| app_id | string | App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present. |
| created_at* | date-time | Server stamp. |
| updated_at* | date-time | Server stamp; updated on every patch. |
| created_by | uuid | Person id from the caller's JWT (sub). |
| updated_by | uuid | Person id from the last writer's JWT (sub). |
| source | string | Provenance tag — defaults to 'edm'. |
| source_type | enum | frontend | backend | server | system | apiWhere the write originated. Defaults to 'api'. |
| is_deleted | boolean | Soft-delete flag. Excluded from default list queries. |
| deleted_at | date-time | Stamped when soft-deleted; null otherwise. |
| deleted_by | uuid | Person id who soft-deleted; null otherwise. |
| schema_version | number | Document schema version. Bumped on incompatible writes. |
| name | string | Human-readable label for this key. |
| key_hash | string | SHA-256 hash of the raw key (unique). Never returned after initial creation. |
| prefix | string | First 8 chars of raw key for UI display, e.g. sk-acme-. |
| kind | string | Key classification. |
| issued_to_user_id | string | User this key was issued to, if kind=user. |
| issued_to_service | string | Service name this key was issued to, if kind=service. |
| scopes | json | Permission scopes granted to this key. |
| allowed_models | json | If kind=virtual_llm, allowlist of model identifiers. |
| tpm_limit | number | Tokens per minute rate limit. |
| rpm_limit | number | Requests per minute rate limit. |
| max_budget_usd | number | Maximum spend cap in USD. |
| spend_usd | number | Cached spend counter in USD. |
| blocked | boolean | Whether this key is blocked from making requests. |
| blocked_reason | string | Reason the key was blocked. |
| last_used_at | date-time | Timestamp of the last successful use of this key. |
| expires_at | date-time | Expiry timestamp; null for non-expiring keys. |
| rotated_from_key_id | string | ID of the key this was rotated from. |
| created_by_user_id | string | ID of the user who created this key. |
| tags | json | Free-form tags. |
| version | number | Optimistic concurrency version counter. |
| application_id | uuid | Owning application id. |
| key_fingerprint | string | SHA-256 hash of the raw key. Raw key is never stored. |
| key_prefix | string | First chars of the raw key for UI display only. |
| status | enum | active | revoked | expiredOperational status of the key. |
API
Loading manifest…