YugabyteDB · Authentication Profile

Yugabytedb Authentication

Authentication

YugabyteDB secures its APIs with apiKey and http across 2 declared security schemes, as derived from its OpenAPI definitions.

Cloud DatabaseDatabaseDBaaSDistributed SQLPostgreSQL
Methods: apiKey, http Schemes: 2 OAuth flows: API key in: header

Security Schemes

bearerAuth http
scheme: bearer
apiKeyAuth apiKey
· in: header (X-AUTH-YW-API-TOKEN)

Source

Authentication Profile

Raw ↑
generated: '2026-07-11'
method: derived
source: openapi/yugabytedb-aeon-openapi.yml, openapi/yugabytedb-anywhere-v1-alerts-monitoring.yaml,
  openapi/yugabytedb-anywhere-v1-backups-restore.yaml, openapi/yugabytedb-anywhere-v1-full.yaml,
  openapi/yugabytedb-anywhere-v1-high-availability.yaml, openapi/yugabytedb-anywhere-v1-providers-infra.yaml,
  openapi/yugabytedb-anywhere-v1-releases-maintenance.yaml, openapi/yugabytedb-anywhere-v1-universes.yaml,
  openapi/yugabytedb-anywhere-v1-users-rbac.yaml, openapi/yugabytedb-anywhere-v2-openapi.yaml
summary:
  types:
  - apiKey
  - http
  api_key_in:
  - header
schemes:
- name: bearerAuth
  type: http
  scheme: bearer
  description: API key obtained from the YugabyteDB Aeon UI under User Profile > API Keys. Pass
    the key as a Bearer token in the Authorization header.
  sources:
  - openapi/yugabytedb-aeon-openapi.yml
- name: apiKeyAuth
  type: apiKey
  in: header
  parameter: X-AUTH-YW-API-TOKEN
  description: API token passed as header
  sources:
  - openapi/yugabytedb-anywhere-v1-alerts-monitoring.yaml
  - openapi/yugabytedb-anywhere-v1-backups-restore.yaml
  - openapi/yugabytedb-anywhere-v1-full.yaml
  - openapi/yugabytedb-anywhere-v1-high-availability.yaml
  - openapi/yugabytedb-anywhere-v1-providers-infra.yaml
  - openapi/yugabytedb-anywhere-v1-releases-maintenance.yaml
  - openapi/yugabytedb-anywhere-v1-universes.yaml
  - openapi/yugabytedb-anywhere-v1-users-rbac.yaml
  - openapi/yugabytedb-anywhere-v2-openapi.yaml