--- title: "List Clusters" method: GET path: "/v4/organizations/{organizationId}/projects/{projectId}/clusters" tags: ["Clusters"] --- # List Clusters `GET /v4/organizations/{organizationId}/projects/{projectId}/clusters` ## Request - Base URL: `https://cloudapi.cloud.couchbase.com` - URL: `https://cloudapi.cloud.couchbase.com/v4/organizations/{organizationId}/projects/{projectId}/clusters` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) Lists all the clusters under the organization. In order to access this endpoint, the provided API key must have at least one of the following roles: - Organization Owner - Project Owner - Project Manager - Project Viewer - Database Data Reader/Writer - Database Data Reader Returned set of clusters is reduced to what the caller has access to view. To learn more, see [Organization, Project, and Database Access Overview](https://docs.couchbase.com/cloud/organizations/organization-projects-overview.html). ## Query parameters - `page` integer - `perPage` integer - `sortBy` string[] - `sortDirection` 'asc' | 'desc' ## Response `200` Successfully listed all the clusters under the organization. - GetClustersResponse - `data` GetClusterResponse[], required - `id` string, uuid, required: The ID of the cluster created. - `appServiceId` string, uuid: The ID of the linked App Service. - `name` string, required: Name of the cluster (up to 256 characters). - `description` string, required: Description of the cluster (up to 1024 characters). - `configurationType` 'singleNode' | 'multiNode', required: - Multi-node databases are best for deployments that require high availability. If your app requires high performance and high availability, choose the Multi-node option. - Single-node databases have resource limitations that make them a good choice for learning, prototyping, and non-production uses. They have limited availability. - Single-node databases should contain only 1 node and 1 Service Group. Adding number of nodes or service groups > 1 is not allowed for such databases. - By default the configurationType is multiNode. - `connectionString` string, required: ConnectionString specifies the Capella database endpoint for your client connection. - `cloudProvider` CloudProvider, required: The cloud provider where the cluster will be hosted. For information about providers and supported regions, see: - [Amazon Web Services](https://docs.couchbase.com/cloud/reference/aws.html) - [Google Cloud Platform](https://docs.couchbase.com/cloud/reference/gcp.html) - [Microsoft Azure](https://docs.couchbase.com/cloud/reference/azure.html) - `type` 'aws' | 'gcp' | 'azure', required: Cloud provider type. Note: For singleNode cluster, only AWS type cloud provider is allowed. 1. `aws`: Amazon Web Services 2. `gcp`: Google Cloud Platform 3. `azure`: Microsoft Azure - `region` string, required: Cloud provider region, for example `us-west-2`. - `cidr` string: CIDR block for Cloud Provider. - `couchbaseServer` CouchbaseServer, required - `version` string: Version of the Couchbase Server to be installed in the cluster. Refer to documentation [here](https://docs.couchbase.com/cloud/clusters/upgrade-database.html#server-version-maintenance-support) for list of supported versions. The latest Couchbase Server version will be deployed by default. - `serviceGroups` ServiceGroup[], required - `node` Node - `compute` Compute, required: Following are the supported compute combinations for CPU and RAM for different cloud providers. To learn more, see [Amazon Web Services](https://docs.couchbase.com/cloud/reference/aws.html). - `cpu` integer, required: CPU units (cores). - `ram` integer, required: RAM units (GB). - `disk` union, required - DiskAWS - `type` 'gp3' | 'io2', required: Type of disk. Please choose from the given list for AWS cloud provider. - `storage` integer, required: Storage in GB. See documentation for supported storage. - `iops` integer, required: Please refer to documentation for supported IOPS. - DiskAzure - `type` 'P6' | 'P10' | 'P15' | 'P20' | 'P30' | 'P40' | 'P50' | 'P60' | 'Ultra', required: Type of disk. Please choose from the given list for Azure cloud provider. - `storage` 64 | 128 | 256 | 512 | 1024 | 2048 | 3072 | 4096 | 5120 | 6144 | 7168 | 8192 | 9216 | 10240 | 11264 | 12288 | 13312 | 14336 | 15360: Storage in GB. Only required for Ultra Disk types. Not used in other storage types. - `iops` integer: Only required for Ultra Disk types. Not used in other storage types. See [IOPS Defaults](https://docs.couchbase.com/cloud/clusters/scale-database.html#IOPS-Defaults) for a list of supported IOPS values. - `autoExpansion` boolean: Determine if disk storage should automatically expand. Defaults to "true" if not specified. - DiskGCP - `type` 'pd-ssd', required: Type of disk. Please choose from the given list for GCP cloud provider. - `storage` integer, required: Storage in GB. Please refer to documentation for supported storage. - `numOfNodes` integer: Number of nodes. The minimum number of nodes for the cluster can be 3 and maximum can be 27 nodes. - Additional service groups can have 2 nodes minimum and 24 nodes maximum. - SingleNode cluster can have only 1 node. - `services` Service[]: The couchbase service to run on the node. The allowed services for singleNode cluster are one or all of - data, index, query and search. - `availability` Availability, required - `type` 'single' | 'multi', required: Availability zone type, either 'single' or 'multi'. Availability zone type allowed for singleNode cluster is only 'single'. - `support` GetClusterSupport, required - `plan` 'basic' | 'developer pro' | 'enterprise' | 'free', required: Plan type, either 'Basic', 'Developer Pro', 'Enterprise' or 'Free'. 'Free' is reported for free tier clusters and cannot be requested when creating or updating a cluster. - `timezone` 'ET' | 'GMT' | 'IST' | 'PT', required: The standard timezone for the cluster. Should be the TZ identifier. - `currentState` 'draft' | 'deploying' | 'scaling' | 'upgrading' | 'rebalancing' | 'peering' | 'destroying' | 'healthy' | 'degraded' | 'turnedOff' | 'turningOff' | 'turningOn' | 'deploymentFailed' | 'scaleFailed' | 'upgradeFailed' | 'rebalanceFailed' | 'peeringFailed' | 'destroyFailed' | 'offline' | 'turningOffFailed' | 'turningOnFailed', required - `audit` CouchbaseAuditData, required - `createdBy` string, required: The user who created the resource; this will be a UUID4 ID for standard users and will be a string such as "internal-support" for internal Couchbase support users. - `createdAt` string, date-time, required: The RFC3339 timestamp associated with when the resource was initially created. - `modifiedBy` string, required: The user who last modified the resource; this will be a UUID4 ID for standard users and will be a string such as "internal-support" for internal Couchbase support users. - `modifiedAt` string, date-time, required: The RFC3339 timestamp associated with when the resource was last modified. - `version` integer, required: The version of the document. This value is incremented each time the resource is modified. - `cmekId` string: The ID of the CMEK Key. - `enablePrivateDNSResolution` boolean - `deletionProtection` boolean, required: Indicates whether deletion protection is enabled for the cluster. When enabled, the cluster cannot be deleted. - `expressScaling` 'enabled' | 'disabled': Current status of Express Scaling. The possible values are: - `enabled`: Express Scaling is active and fully functional - `disabled`: Express Scaling is not enabled - `cursor` Cursor, required - `pages` Pages, required - `page` integer, required: Current page of results, starting from page 1. - `next` integer: Number of the next page of results. Not set on the last page. - `previous` integer: Number of the previous page of results. Not set on the first page. - `last` integer, required: Number of the last page of results. - `perPage` integer, required: Number of items displayed in each page. - `totalItems` integer, required: Total items found by the given query. - `hrefs` Hrefs, required - `first` string, uri, required: The base URL, endpoint, and path parameters required to fetch the first page of results. - `last` string, uri, required: The base URL, endpoint, and path parameters required to fetch the last page of results. - `previous` string, uri, required: The base URL, endpoint, and path parameters required to fetch the previous page of results. Empty if there is no previous page. - `next` string, uri, required: The base URL, endpoint, and path parameters required to fetch the next page of results. Empty if there is no next page. ## Other responses - `400`: Returned when we are unable to decode the recevied payload. - `403`: The client does not have the necessary permissions to access this resource. - `404`: The requested resource was not found. - `429`: Returned when the client exceeds the rate limit for the given APIKey. - `500`: An unexpected error occurred in the server while processing this request. ## Changes - **2026-10-19** `a5e88bcf71cb`: 1 warning - added the new `free` enum value to the `data/items/support/plan` response property for the response status `200` - **2026-08-06** `e67df5d1f74e`: 1 info - added the required property `data/items/deletionProtection` to the response with the `200` status [Operation history](https://skmtc.dev/couchbase/apis/couchbase-capella-management-api/changes/v4/organizations/:organizationId/projects/:projectId/clusters/get.md) --- [API](https://skmtc.dev/couchbase/apis/couchbase-capella-management-api.md) - [All operations](https://skmtc.dev/couchbase/apis/couchbase-capella-management-api/llms.txt) - [OpenAPI document](https://skmtc.dev/couchbase/apis/couchbase-capella-management-api/revisions/a5e88bcf71cb?raw)