{ "opencollection": "1.0.0", "info": { "name": "Couchbase Analytics Service REST Allowed CIDRs Clusters API", "version": "7.6" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "Clusters", "type": "folder" }, "items": [ { "info": { "name": "List clusters", "type": "http" }, "http": { "method": "GET", "url": "https://localhost:8095/v4/organizations/:organizationId/projects/:projectId/clusters", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The UUID of the organization" }, { "name": "projectId", "value": "", "type": "path", "description": "The UUID of the project" }, { "name": "page", "value": "", "type": "query", "description": "Page number for pagination" }, { "name": "perPage", "value": "", "type": "query", "description": "Number of items per page" } ] }, "docs": "Returns the list of database clusters within the specified project." }, { "info": { "name": "Create a cluster", "type": "http" }, "http": { "method": "POST", "url": "https://localhost:8095/v4/organizations/:organizationId/projects/:projectId/clusters", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The UUID of the organization" }, { "name": "projectId", "value": "", "type": "path", "description": "The UUID of the project" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Provisions a new Couchbase Capella database cluster in the specified project. You can configure the cloud provider, region, instance type, storage, and services." }, { "info": { "name": "Get cluster details", "type": "http" }, "http": { "method": "GET", "url": "https://localhost:8095/v4/organizations/:organizationId/projects/:projectId/clusters/:clusterId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The UUID of the organization" }, { "name": "projectId", "value": "", "type": "path", "description": "The UUID of the project" }, { "name": "clusterId", "value": "", "type": "path", "description": "The UUID of the cluster" } ] }, "docs": "Returns detailed information about a specific cluster including its configuration, status, and connection string." }, { "info": { "name": "Update a cluster", "type": "http" }, "http": { "method": "PUT", "url": "https://localhost:8095/v4/organizations/:organizationId/projects/:projectId/clusters/:clusterId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The UUID of the organization" }, { "name": "projectId", "value": "", "type": "path", "description": "The UUID of the project" }, { "name": "clusterId", "value": "", "type": "path", "description": "The UUID of the cluster" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration of an existing cluster, such as scaling the number of nodes or changing the support plan." }, { "info": { "name": "Delete a cluster", "type": "http" }, "http": { "method": "DELETE", "url": "https://localhost:8095/v4/organizations/:organizationId/projects/:projectId/clusters/:clusterId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The UUID of the organization" }, { "name": "projectId", "value": "", "type": "path", "description": "The UUID of the project" }, { "name": "clusterId", "value": "", "type": "path", "description": "The UUID of the cluster" } ] }, "docs": "Deletes the specified cluster and all its data. This action is irreversible." } ] } ], "bundled": true }