API Routes Route map for Athena gateway, admin, management, and cluster surfaces.
Use the canonical OpenAPI documents for exact request/response schemas:
/openapi.yaml and /openapi-wss.yaml.
Every Athena HTTP and WebSocket operation is documented in:
Reference -> Athena API Reference
Use this page as a grouped route map, then open the generated operation pages for
request/response details, operation summaries, and auth requirements.
Surface Required Headers Gateway PostgreSQL routes (`/gateway/fetch data SQL routes (/query/sql, /gateway/sql) with driver=postgresql Same as gateway PostgreSQL routes above. SQL routes (/query/sql, /gateway/sql) with non-PostgreSQL driver (athena/scylla/supabase) Standard key auth required (X-Athena-Key/apikey/x-api-key) and route rights enforced. RPC + Pipelines + Schema + Storage surfaces X-Athena-Client + API key headers (apikey or x-api-key)Admin + Management + Provisioning + Backup + Public route administration X-Athena-Client + admin key headers (x-athena-admin-key)Runtime introspection (/, /ping, /openapi.yaml, /openapi-wss.yaml, /wss/info) No client scoping required WebSocket gateway (/wss/gateway) WebSocket upgrade headers plus forwarded Athena auth headers in message payload
See the generated Athena API Reference operation pages for the exact per-operation
security requirement metadata.
Method Path Purpose GET/Basic service liveness GET/pingLightweight health check GET/health/clusterPer-client health and latency GET/metricsPrometheus metrics
/gateway/fetch now has two valid request families:
legacy columns + conditions
PostgreSQL-backed structured select / AST payloads
See Gateway Structured Select for the
canonical nested-select contract.
Method Path POST/gateway/fetchPOST/gateway/dataGET/dataPUT/gateway/insertPOST/gateway/updateDELETE/gateway/deletePOST/gateway/queryPOST/gateway/sqlPOST/query/sqlPOST/query/countPOST/gateway/rpcGET/POST/rpc/{function_name}
Method Path GET/gateway/deferred/{request_id}POST/gateway/deferred/{request_id}/requeuePOST/pipelinesPOST/pipelines/simulateGET/pipelines/templatesGET/wss/infoGET/openapi-wss.yaml
Method Path GET/management/capabilitiesPOST/management/tablesPATCH/DELETE/management/tables/{table_name}DELETE/management/tables/{table_name}/columns/{column_name}POST/management/indexesDELETE/management/indexes/{index_name}POST/management/extensions/installGET/POST/DELETE/management/functions
Method Path Prefix */admin/api-keys*/admin/api-key-rights*/admin/api-key-config*/admin/api-key-clients*/admin/clients*/admin/backups*/admin/provision*/admin/public-routesGET/admin/vacuum-healthGET/admin/admission-events
Method Path Prefix GET/router/registryGET/registryGET/schema/*GET/clients*/storage/objects**/storage/buckets/cors*
Method Path GET/openapi.yamlGET/docs