Sign in

v1

latestOpenAPI 3.0.22026-08-062794201004.1 KB
Clusters

List Clusters

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.

get/v4/organizations/{organizationId}/projects/{projectId}/clusters

Query parameters

pageinteger

Sets the page you would like to view.

perPageinteger

Sets the number of results you would like to have on each page.

sortBystring[]

Sets the order of how you would like to sort the results and the key you would like to order by. Valid fields to sort the results are: id, availability, cloudProvider, couchbaseServer, currentState, name.

sortDirection'asc' | 'desc'

The order in which the items will be sorted.

Response

Successfully listed all the clusters under the organization.

Example response

{
  "data": [
    {
      "id": "ffffffff-aaaa-1414-eeee-000000000000",
      "appServiceId": "ffffffff-aaaa-1414-eeee-000000000000",
      "name": "Test Cluster",
      "description": "Description of the cluster",
      "configurationType": "multiNode",
      "connectionString": "couchbases://cb.irxmynm6vekhe5.cloud.couchbase.com",
      "cloudProvider": {
        "type": "aws",
        "region": "us-east-1",
        "cidr": "10.1.30.0/23"
      },
      "couchbaseServer": {
        "version": "7.1"
      },
      "serviceGroups": [
        {
          "node": {
            "compute": {
              "cpu": 4,
              "ram": 16
            },
            "disk": {
              "type": "gp3",
              "storage": 50,
              "iops": 3000
            }
          },
          "numOfNodes": 3,
          "services": [
            "data"
          ]
        }
      ],
      "availability": {
        "type": "single"
      },
      "support": {
        "plan": "basic",
        "timezone": "ET"
      },
      "currentState": "deploying",
      "audit": {
        "createdBy": "ffffffff-aaaa-1414-eeee-000000000000",
        "createdAt": "2021-09-01T12:34:56Z",
        "modifiedBy": "ffffffff-aaaa-1414-eeee-000000000000",
        "modifiedAt": "2021-09-01T12:34:56Z",
        "version": 1
      },
      "cmekId": "ffffffff-aaaa-1414-eeee-000000000000",
      "expressScaling": "enabled"
    }
  ],
  "cursor": {
    "pages": {
      "page": 2,
      "next": 3,
      "previous": 1,
      "last": 10,
      "perPage": 10,
      "totalItems": 10
    },
    "hrefs": {
      "first": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "last": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "previous": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "next": "https://cloud.couchbase.com/v4/users?page=1&perPage=10"
    }
  }
}