{ "info": { "_postman_id": "85304124-0fe3-415b-b753-84c65df2bc5b", "name": "CockroachDB Cloud APIKeys Nodes API", "description": "The CockroachDB Cloud API is a REST interface that provides programmatic access to manage the lifecycle of clusters within a CockroachDB Cloud organization. It enables developers and operators to create, configure, scale, and delete CockroachDB Serverless and Dedicated clusters without using the web console. The API supports cluster provisioning, node management, network authorization, customer-managed encryption keys, backup and restore, log and metric export, role management, and folder organization. Authentication is handled via bearer tokens, and the API is rate-limited to 10 requests per second per user.\n\nContact Support:\n Name: Cockroach Labs Support", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:23:37.000Z", "updatedAt": "2026-07-28T01:23:37.000Z", "lastUpdatedBy": "35240", "uid": "35240-85304124-0fe3-415b-b753-84c65df2bc5b" }, "item": [ { "name": "api", "item": [ { "name": "v2", "item": [ { "name": "nodes", "item": [ { "name": "List nodes", "id": "7e377329-7db7-487d-ad18-964f87d191ae", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/nodes/?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "nodes", "" ], "query": [ { "description": "Maximum number of results to return in a single response.", "key": "limit", "value": "" }, { "description": "Number of results to skip before returning data. Used for offset-based pagination.", "key": "offset", "value": "" } ] }, "description": "Returns information about all nodes in the cluster, including each node's address, build information, locality, store metrics, and operational status. Requires admin-level authentication." }, "response": [ { "id": "cdfca162-0832-4c20-b635-2f986adf52de", "name": "List of cluster nodes returned successfully.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/nodes/?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "nodes", "" ], "query": [ { "description": "Maximum number of results to return in a single response.", "key": "limit", "value": "" }, { "description": "Number of results to skip before returning data. Used for offset-based pagination.", "key": "offset", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"nodes\": [\n {\n \"desc\": {\n \"node_id\": \"\",\n \"address\": {\n \"network_field\": \"\",\n \"address_field\": \"\"\n },\n \"attrs\": {},\n \"locality\": {\n \"tiers\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"server_version\": {},\n \"build_tag\": \"\",\n \"started_at\": \"\",\n \"cluster_name\": \"\",\n \"sql_address\": {\n \"network_field\": \"\",\n \"address_field\": \"\"\n }\n },\n \"build_info\": {\n \"go_version\": \"\",\n \"tag\": \"\",\n \"time\": \"\",\n \"revision\": \"\",\n \"cgo_compiler\": \"\",\n \"platform\": \"\",\n \"distribution\": \"\",\n \"type\": \"\",\n \"channel\": \"\"\n },\n \"started_at\": \"\",\n \"updated_at\": \"\",\n \"metrics\": {\n \"utf4\": \"\"\n },\n \"args\": [\n \"\",\n \"\"\n ],\n \"env\": [\n \"\",\n \"\"\n ],\n \"activity\": {}\n },\n {\n \"desc\": {\n \"node_id\": \"\",\n \"address\": {\n \"network_field\": \"\",\n \"address_field\": \"\"\n },\n \"attrs\": {},\n \"locality\": {\n \"tiers\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"server_version\": {},\n \"build_tag\": \"\",\n \"started_at\": \"\",\n \"cluster_name\": \"\",\n \"sql_address\": {\n \"network_field\": \"\",\n \"address_field\": \"\"\n }\n },\n \"build_info\": {\n \"go_version\": \"\",\n \"tag\": \"\",\n \"time\": \"\",\n \"revision\": \"\",\n \"cgo_compiler\": \"\",\n \"platform\": \"\",\n \"distribution\": \"\",\n \"type\": \"\",\n \"channel\": \"\"\n },\n \"started_at\": \"\",\n \"updated_at\": \"\",\n \"metrics\": {\n \"quis_4f6\": \"\",\n \"labore_2de\": \"\",\n \"ipsum_d\": \"\"\n },\n \"args\": [\n \"\",\n \"\"\n ],\n \"env\": [\n \"\",\n \"\"\n ],\n \"activity\": {}\n }\n ],\n \"next\": \"\"\n}", "createdAt": "2026-07-28T01:23:38.000Z", "updatedAt": "2026-07-28T01:23:38.000Z", "uid": "35240-cdfca162-0832-4c20-b635-2f986adf52de" }, { "id": "ea51217e-df88-46a9-88e8-d06611f5c37f", "name": "Authentication is required. The X-Cockroach-API-Session header is missing or the session has expired.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/nodes/?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "nodes", "" ], "query": [ { "description": "Maximum number of results to return in a single response.", "key": "limit", "value": "" }, { "description": "Number of results to skip before returning data. Used for offset-based pagination.", "key": "offset", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": \"\"\n}", "createdAt": "2026-07-28T01:23:38.000Z", "updatedAt": "2026-07-28T01:23:38.000Z", "uid": "35240-ea51217e-df88-46a9-88e8-d06611f5c37f" }, { "id": "422c4cf8-73f3-46fe-b5fb-576a13a7c49c", "name": "The authenticated user does not have admin privileges required to access this endpoint.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/nodes/?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "nodes", "" ], "query": [ { "description": "Maximum number of results to return in a single response.", "key": "limit", "value": "" }, { "description": "Number of results to skip before returning data. Used for offset-based pagination.", "key": "offset", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": \"\"\n}", "createdAt": "2026-07-28T01:23:38.000Z", "updatedAt": "2026-07-28T01:23:38.000Z", "uid": "35240-422c4cf8-73f3-46fe-b5fb-576a13a7c49c" } ], "createdAt": "2026-07-28T01:23:38.000Z", "updatedAt": "2026-07-28T01:23:38.000Z", "uid": "35240-7e377329-7db7-487d-ad18-964f87d191ae" } ], "id": "edbd0dc5-8031-4428-9b5d-1986eb584cb4", "createdAt": "2026-07-28T01:23:38.000Z", "updatedAt": "2026-07-28T01:23:38.000Z", "uid": "35240-edbd0dc5-8031-4428-9b5d-1986eb584cb4" } ], "id": "5851ae91-3e15-4950-9750-d5da7a3a536a", "createdAt": "2026-07-28T01:23:38.000Z", "updatedAt": "2026-07-28T01:23:38.000Z", "uid": "35240-5851ae91-3e15-4950-9750-d5da7a3a536a" } ], "id": "afe0cede-cc64-4af3-bcbf-9b4edb6c2f01", "createdAt": "2026-07-28T01:23:38.000Z", "updatedAt": "2026-07-28T01:23:38.000Z", "uid": "35240-afe0cede-cc64-4af3-bcbf-9b4edb6c2f01" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://cockroachlabs.cloud" } ] }