API Reference
Getting Started
Core Concepts
Backend API — Guides
Frontend API — Guides
OAuth & OpenID Connect — Guides
Enterprise: SSO & SCIM — Guides
Webhooks — Guides
SDKs
Backend API (BAPI)
Frontend API (FAPI)
Dashboard API
Public API
SCIM
OIDC
Platform

Api Keys

AdminUpdated Sep 11, 2026

Api Keys

Dashboard API — authenticated by an Atlas console (platform-instance) session, not a key.

4 routes. Each row is one endpoint with its explanation and whether it honours the Idempotency-Key header.

Method & path

Idem

Explanation

GET /v1/dashboard/accounts/:accountId/instances/:instanceId/api_keys

Keys with last-used and a stale flag, plus the scope catalog.

POST /v1/dashboard/accounts/:accountId/instances/:instanceId/api_keys/:keyId/rotate

Mint a replacement with the same scopes. The old key keeps working until revoked.

POST /v1/dashboard/accounts/:accountId/instances/:instanceId/api_keys/:keyId/revoke

Revoke a key. The row is kept so the audit log can still name it.

POST /v1/dashboard/accounts/:accountId/instances/:instanceId/api_keys

Mint a secret key. Returned exactly once.

Was this page helpful?