{ "opencollection": "1.0.0", "info": { "name": "CockroachDB Cloud APIKeys Health API", "version": "2024-09-16" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Health", "type": "folder" }, "items": [ { "info": { "name": "Check node health", "type": "http" }, "http": { "method": "GET", "url": "https://cockroachlabs.cloud/api/v2/health/", "params": [ { "name": "ready", "value": "", "type": "query", "description": "If true, checks whether the node is fully ready to accept SQL connections in addition to being live." } ] }, "docs": "Reports the health of the CockroachDB node. When the optional ready parameter is set to true, the endpoint also verifies that the node is fully operational and ready to accept SQL connections. Returns HTTP 200 if healthy, or HTTP 500 if not ready. This endpoint does not require authentication." } ] } ], "bundled": true }