{ "info": { "_postman_id": "0ffd43ff-6f6e-4982-a9ce-d02f363064fe", "name": "CockroachDB Cloud APIKeys VersionDeferral 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:24:12.000Z", "updatedAt": "2026-07-28T01:24:12.000Z", "lastUpdatedBy": "35240", "uid": "35240-0ffd43ff-6f6e-4982-a9ce-d02f363064fe" }, "item": [ { "name": "api", "item": [ { "name": "v1", "item": [ { "name": "clusters", "item": [ { "name": "{cluster_id}", "item": [ { "name": "version-deferral", "item": [ { "name": "Get version deferral", "id": "ee72938c-8708-4875-8bda-d2a54a129053", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/clusters/:cluster_id/version-deferral", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "clusters", ":cluster_id", "version-deferral" ], "variable": [ { "id": "f1cfc67c-f497-41a2-9033-ea38337ad7fd", "key": "cluster_id", "value": "", "description": "(Required) Unique identifier of the CockroachDB Cloud cluster." } ] }, "description": "Retrieves the version deferral policy for the specified cluster, indicating whether automatic version upgrades are deferred and for how long." }, "response": [ { "id": "4ab8a159-4bdd-4932-aab6-2c1e1447c9b5", "name": "Version deferral policy retrieved 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/v1/clusters/:cluster_id/version-deferral", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "clusters", ":cluster_id", "version-deferral" ], "variable": [ { "key": "cluster_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"deferral_policy\": \"FIXED_DEFERRAL\"\n}", "createdAt": "2026-07-28T01:24:12.000Z", "updatedAt": "2026-07-28T01:24:12.000Z", "uid": "35240-4ab8a159-4bdd-4932-aab6-2c1e1447c9b5" }, { "id": "033df4b1-7d62-483d-8f69-e52f3afb9a17", "name": "Authentication credentials are missing or invalid.", "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/v1/clusters/:cluster_id/version-deferral", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "clusters", ":cluster_id", "version-deferral" ], "variable": [ { "key": "cluster_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:24:12.000Z", "updatedAt": "2026-07-28T01:24:12.000Z", "uid": "35240-033df4b1-7d62-483d-8f69-e52f3afb9a17" }, { "id": "755f36d8-ed47-4ea7-aff8-a820b984e195", "name": "The requested resource was not found.", "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/v1/clusters/:cluster_id/version-deferral", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "clusters", ":cluster_id", "version-deferral" ], "variable": [ { "key": "cluster_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:24:12.000Z", "updatedAt": "2026-07-28T01:24:12.000Z", "uid": "35240-755f36d8-ed47-4ea7-aff8-a820b984e195" } ], "createdAt": "2026-07-28T01:24:12.000Z", "updatedAt": "2026-07-28T01:24:12.000Z", "uid": "35240-ee72938c-8708-4875-8bda-d2a54a129053" }, { "name": "Set version deferral", "id": "ff95bf27-d020-426b-9fc1-3b803e75cdc0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"deferral_policy\": \"FIXED_DEFERRAL\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/clusters/:cluster_id/version-deferral", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "clusters", ":cluster_id", "version-deferral" ], "variable": [ { "id": "8c25bcd9-9e3e-4e41-a93a-77bac0424d92", "key": "cluster_id", "value": "", "description": "(Required) Unique identifier of the CockroachDB Cloud cluster." } ] }, "description": "Sets the version deferral policy for the specified cluster to delay automatic CockroachDB version upgrades." }, "response": [ { "id": "fbfdca4b-4001-4951-bb56-44d1bded627d", "name": "Version deferral policy set successfully.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"deferral_policy\": \"FIXED_DEFERRAL\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/clusters/:cluster_id/version-deferral", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "clusters", ":cluster_id", "version-deferral" ], "variable": [ { "key": "cluster_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"deferral_policy\": \"FIXED_DEFERRAL\"\n}", "createdAt": "2026-07-28T01:24:12.000Z", "updatedAt": "2026-07-28T01:24:12.000Z", "uid": "35240-fbfdca4b-4001-4951-bb56-44d1bded627d" }, { "id": "6aea6d7f-d9b9-4026-bf68-9618a9f65a26", "name": "The request body or parameters are invalid.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"deferral_policy\": \"FIXED_DEFERRAL\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/clusters/:cluster_id/version-deferral", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "clusters", ":cluster_id", "version-deferral" ], "variable": [ { "key": "cluster_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:24:12.000Z", "updatedAt": "2026-07-28T01:24:12.000Z", "uid": "35240-6aea6d7f-d9b9-4026-bf68-9618a9f65a26" }, { "id": "a8a5d22e-ce1b-47f0-8cf7-4ab6ba5cbb85", "name": "Authentication credentials are missing or invalid.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"deferral_policy\": \"FIXED_DEFERRAL\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/clusters/:cluster_id/version-deferral", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "clusters", ":cluster_id", "version-deferral" ], "variable": [ { "key": "cluster_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:24:12.000Z", "updatedAt": "2026-07-28T01:24:12.000Z", "uid": "35240-a8a5d22e-ce1b-47f0-8cf7-4ab6ba5cbb85" } ], "createdAt": "2026-07-28T01:24:12.000Z", "updatedAt": "2026-07-28T01:24:12.000Z", "uid": "35240-ff95bf27-d020-426b-9fc1-3b803e75cdc0" } ], "id": "94d6c909-ce61-4ede-af5e-352545bc5db2", "createdAt": "2026-07-28T01:24:12.000Z", "updatedAt": "2026-07-28T01:24:12.000Z", "uid": "35240-94d6c909-ce61-4ede-af5e-352545bc5db2" } ], "id": "c41de7d7-00c8-40b6-813a-bbbb7a1bfe82", "createdAt": "2026-07-28T01:24:12.000Z", "updatedAt": "2026-07-28T01:24:12.000Z", "uid": "35240-c41de7d7-00c8-40b6-813a-bbbb7a1bfe82" } ], "id": "15646f91-f9b0-436e-ab0c-bf55d01c5d05", "createdAt": "2026-07-28T01:24:12.000Z", "updatedAt": "2026-07-28T01:24:12.000Z", "uid": "35240-15646f91-f9b0-436e-ab0c-bf55d01c5d05" } ], "id": "a382d45c-5a95-4df4-81de-0e084263ad55", "createdAt": "2026-07-28T01:24:12.000Z", "updatedAt": "2026-07-28T01:24:12.000Z", "uid": "35240-a382d45c-5a95-4df4-81de-0e084263ad55" } ], "id": "a16823ac-cd5a-41b1-b7c4-fb26b8cd70f6", "createdAt": "2026-07-28T01:24:12.000Z", "updatedAt": "2026-07-28T01:24:12.000Z", "uid": "35240-a16823ac-cd5a-41b1-b7c4-fb26b8cd70f6" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://cockroachlabs.cloud" } ] }