CockroachDB · Authentication Profile

Cockroachdb Authentication

Authentication

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

Cluster ManagementCloudDatabaseDistributed SQLInfrastructurePostgreSQL CompatibleSQL
Methods: apiKey, http Schemes: 2 OAuth flows: API key in: header

Security Schemes

bearerAuth http
scheme: bearer
sessionAuth apiKey
· in: header (X-Cockroach-API-Session)

Source

Authentication Profile

Raw ↑ 
generated: '2026-07-11'
method: derived
source: openapi/cockroachdb-cloud-api-openapi.yml, openapi/cockroachdb-cluster-api-openapi.yml
summary:
  types:
  - apiKey
  - http
  api_key_in:
  - header
schemes:
- name: bearerAuth
  type: http
  scheme: bearer
  description: Bearer token authentication. Generate a token in the CockroachDB Cloud Console
    under Organization Settings > API Access.
  sources:
  - openapi/cockroachdb-cloud-api-openapi.yml
- name: sessionAuth
  type: apiKey
  in: header
  parameter: X-Cockroach-API-Session
  description: Session token obtained from the /api/v2/login/ endpoint. Include this header
    with all authenticated requests.
  sources:
  - openapi/cockroachdb-cluster-api-openapi.yml