API Overview
Athena endpoint families and how they fit together.
Athena exposes a broad API grouped by responsibility.
Gateway + Query
/gateway/fetch,/gateway/insert,/gateway/update,/gateway/delete/gateway/query,/gateway/sql,/query/sql,/query/count/gateway/rpc,/rpc/{function_name}/rest/v1/{table}compatibility routes
Pipelines + Deferred Execution
/pipelines,/pipelines/simulate,/pipelines/templates/gateway/deferred/{request_id},/gateway/deferred/{request_id}/requeue
Schema + Introspection
/schema/tables,/schema/columns,/schema/migrations/schema/clients,/clients
Admin + Operations
/admin/clients*,/admin/api-keys*,/admin/backups*/admin/provision*,/admin/public-routes*/admin/webhooks*,/admin/admission-events/admin/vacuum-health*, optimization and stats routes
Storage + Public Access
/storage/objects*,/storage/objects/head/storage/buckets/list,/storage/buckets/create,/storage/buckets/delete,/storage/buckets/cors*/public/{route_key}/{op}
Optimization + Admission
/admin/clients/{client_name}/query-optimizations*/admin/vacuum-health*/admin/admission-events
Management DDL Surface
/management/tables*,/management/indexes*/management/extensions/install/management/functions/management/capabilities
Observability + Contracts
/health/cluster,/metrics,/router/registry/openapi.yaml,/openapi-wss.yaml,/wss/info
Security and rate limits
- Security, auth ordering, and rate limits — storage auth before JSON, protected schema/registry/OpenAPI, raw SQL rights, backup admin, inbound/outbound rate limits, stats typing, and ops checklist.
- Gateway API Keys — the full runtime key model: creation, client binding, rights, IP policy, virgin lock-in, and fail modes.
Required Header Pattern
For most scoped calls:
X-Athena-Client: <logical-client-name>For protected routes, include API key or admin key headers according to rights model.
For full route-level coverage, use Reference -> Athena API Reference.