Sign in

v1

latestOpenAPI 3.0.22026-08-062794201004.1 KB
Clusters

Create Cluster

Creates a new Couchbase Capella provisioned cluster.

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

To learn more, see Organization, Project, and Database Access Overview.

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

Request body

namestring required

Name of the cluster (up to 256 characters).

descriptionstring

Description of the cluster (up to 1024 characters).

configurationType'singleNode' | 'multiNode'
  • 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.
zonesstring[]

Zones is the cloud services provider availability zones for the cluster. Currently Supported only for single AZ clusters so only 1 zone is allowed in list.

cmekIdstring uuid

The ID of the CMEK Key.

enablePrivateDNSResolutionboolean

EnablePrivateDNSResolution signals that the cluster should have hostnames that are hosted in a public DNS zone that resolve to a private DNS address. This exists to support the use case of customers connecting from their own data centers where it is not possible to make use of a cloud service provider DNS zone.

Example request

{
  "name": "Test Cluster",
  "description": "Description of the cluster",
  "configurationType": "multiNode",
  "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"
  },
  "zones": [
    "use1-az1"
  ],
  "cmekId": "ffffffff-aaaa-1414-eeee-000000000000",
  "enablePrivateDNSResolution": true
}

Response

Successfully created a cluster.

idstring uuid required

The ID of the cluster created.

Example response

{
  "id": "ffffffff-aaaa-1414-eeee-000000000000"
}