Cockroach Labs Health API
Check the health and readiness of individual CockroachDB nodes. The health endpoint can report whether the node is live and fully operational for accepting SQL connections.
Cockroach Labs Health API is one of 26 APIs that Cockroach Labs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Health. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 1 operation across 1 path, and defines 1 schema. It is described by OpenAPI 3.2.0, at version 2.0.0.
Requests are made against a single base URL, https://localhost:8080.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Cockroach Labs Health API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as X-Cockroach-API-Session (sessionAuth).
By default, every request must be authenticated.
sessionAuth— Session token obtained from the /api/v2/login/ endpoint. Include this header with all authenticated requests.
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.
Check the health and readiness of individual CockroachDB nodes. The health endpoint can report whether the node is live and fully operational for accepting SQL connections.
Schemas 1
The contract defines 1 schema that model the data the API accepts and returns. The most detailed is HealthResponse (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Cockroach Labs 12
Other APIs Cockroach Labs publishes across the network.
This is an independent, third-party profile of Cockroach Labs Health API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.