Athena

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.

Complete Route Coverage

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.

Auth Requirements By Surface

SurfaceRequired Headers
Gateway + Query + RPC + Pipelines + Schema + StorageX-Athena-Client + API key headers (apikey or x-api-key)
Admin + Management + Provisioning + Backup + Public route administrationX-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.

Core Runtime

MethodPathPurpose
GET/Basic service liveness
GET/pingLightweight health check
GET/health/clusterPer-client health and latency
GET/metricsPrometheus metrics

Gateway + Query

MethodPath
POST/gateway/fetch
POST/gateway/data
GET/data
PUT/gateway/insert
POST/gateway/update
DELETE/gateway/delete
POST/gateway/query
POST/gateway/sql
POST/query/sql
POST/query/count
POST/gateway/rpc
GET/POST/rpc/{function_name}

Deferred + Pipelines + Realtime

MethodPath
GET/gateway/deferred/{request_id}
POST/gateway/deferred/{request_id}/requeue
POST/pipelines
POST/pipelines/simulate
GET/pipelines/templates
GET/wss/info
GET/openapi-wss.yaml

Management (DDL + Function Ops)

MethodPath
GET/management/capabilities
POST/management/tables
PATCH/DELETE/management/tables/{table_name}
DELETE/management/tables/{table_name}/columns/{column_name}
POST/management/indexes
DELETE/management/indexes/{index_name}
POST/management/extensions/install
GET/POST/DELETE/management/functions

Admin + Operations

MethodPath Prefix
*/admin/api-keys
*/admin/api-key-rights
*/admin/api-key-config
*/admin/api-key-clients
*/admin/clients
*/admin/backups
*/admin/provision
*/admin/public-routes
GET/admin/vacuum-health
GET/admin/admission-events

Introspection + Storage

MethodPath Prefix
GET/router/registry
GET/registry
GET/schema/*
GET/clients
*/storage/objects*
*/storage/buckets/cors*

Contract + Docs

MethodPath
GET/openapi.yaml
GET/docs