COcouchbase
Free Tier

Create Free Tier Cluster

Creates a free tier cluster. This is a 1 node cluster than only runs data, query, index and search services.

You can have at most 1 free tier cluster per tenant.

The following features are not available for free tier clusters:

  • backup/restore
  • private endpoint service
  • network peering
  • audit logs
  • alert integration
  • CMEK
  • on/off schedule

Only cluster name, description, CSP, region and CIDR are configurable.

There are limited regions available based on CSP: a. for AWS they are us-east-2, eu-west-1, ap-southeast-1 b. for GCP they are us-west1, europe-west1, asia-east1 c. for Azure they are eastus, swedencentral, koreacentral

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/freeTier

Request

Request body

namestring required

Name of the cluster (up to 256 characters).

descriptionstring

Description of the cluster (up to 1024 characters).

Example request

{
  "name": "A Free Tier Cluster",
  "description": "Description of the cluster",
  "cloudProvider": {
    "type": "aws",
    "region": "us-east-1",
    "cidr": "10.1.30.0/23"
  }
}

Response

Successfully submitted job to create a free tier cluster.

idstring uuid required

The ID of the cluster created.

Example response

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

Changes

No recorded changes to this operation across all 5 revisions of this API.