Couchbase Public API
API reference guide for the Couchbase Cloud Public API.
You can find this reference as an openapi.yaml file to import into tools such as Postman, Insomnia or similar, here.
| The API is regularly updated along with the documentation. In the process, documentation may be built first — so it is possible that a new endpoint listed here may be some hours from reaching the API. |
Endpoints
Clouds
clouds/list
GET /v2/clouds
List Clouds
Clusters
clusters/create
POST /v2/clusters
Create cluster
clusters/createAllowlistEntry
POST /v2/clusters/{id}/allowlist
Adds entry to allowlist
clusters/createBucket
POST /v2/clusters/{id}/buckets
Create bucket in cluster
clusters/createUser
POST /v2/clusters/{id}/users
Create Database User
Description
Creates Database user. A database user entity is required for applications to remotely authenticate on a cluster and access bucket data
clusters/delete
DELETE /v2/clusters/{id}
Delete cluster
clusters/deleteAllowlistEntry
DELETE /v2/clusters/{id}/allowlist
Delete entry from allowlist
clusters/deleteBucket
DELETE /v2/clusters/{id}/buckets
Delete bucket in cluster
clusters/deleteUser
DELETE /v2/clusters/{id}/users/{username}
Delete Database User
clusters/getAllowlist
GET /v2/clusters/{id}/allowlist
Get current allowlist
clusters/getCertificate
GET /v2/clusters/{id}/certificate
Get Cluster Certificate
Description
Retrieve a self-signed certificate to securely connect to the cluster. Required for both public and private connections.
clusters/health
GET /v2/clusters/{id}/health
Get Cluster Health
Description
Retrieve Cluster health and status. Health stats of the cluster are returned only for clusters with ready status.
clusters/list
GET /v2/clusters
List Clusters
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
page |
Sets how many results you would like to have on each page |
- |
null |
|
perPage |
Sets what page you would like to view |
- |
null |
|
sortBy |
Sets order of how you would like to sort results and also the key you would like to order by |
- |
null |
|
cloudId |
Cloud ID for filtering cloud clusters. |
- |
null |
|
projectId |
Project ID for filtering project clusters. |
- |
null |
clusters/listBuckets
GET /v2/clusters/{id}/buckets
List cluster buckets
clusters/listUsers
GET /v2/clusters/{id}/users
List Database Users
clusters/show
GET /v2/clusters/{id}
Get Cluster
clusters/status
GET /v2/clusters/{id}/status
Get Cluster Status
clusters/updateAllowlist
PUT /v2/clusters/{id}/allowlist
Update the allowlist for a cluster
clusters/updateBucket
PUT /v2/clusters/{id}/buckets
Update bucket in cluster
clusters/updateUser
PUT /v2/clusters/{id}/users/{username}
Update Database User
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
id |
Cluster ID |
X |
null |
|
username |
Database User username |
X |
null |
Projects
projects/create
POST /v2/projects
Create project
projects/delete
DELETE /v2/projects/{id}
Delete project
projects/list
GET /v2/projects
List Projects
Models
AWSProviderSettings
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
region |
||||
bucket |
||||
supportBucket |
||||
accountId |
||||
vpcCidr |
||||
vpcId |
||||
stackId |
||||
privateSubnets |
List of [string] |
|||
availabilityZone |
List of [string] |
|||
azCount |
||||
lastRotated |
date-time |
AllowListEntry
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
cidrBlock |
X |
|||
ruleType |
X |
|||
duration |
||||
createdAt |
date-time |
|||
expiresAt |
date-time |
|||
updatedAt |
date-time |
|||
comment |
||||
state |
AppendAllowListRequest
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
cidrBlock |
X |
|||
ruleType |
X |
|||
comment |
||||
duration |
The duration you would like the temporary cidr block to be active |
AwsInstances
Allowable Values
m5.large, m5.xlarge, m5.2xlarge, m5.4xlarge, m5.8xlarge, m5.12xlarge, m5.16xlarge, m5.24xlarge, r5.large, r5.xlarge, r5.2xlarge, r5.4xlarge, r5.8xlarge, r5.12xlarge, r5.24xlarge, c5.large, c5.xlarge, c5.2xlarge, c5.4xlarge, c5.9xlarge, c5.12xlarge, c5.18xlarge, x1.16xlarge, x1.32xlarge
AzureInstances
Allowable Values
Standard_F4s_v2, Standard_F8s_v2, Standard_F16s_v2, Standard_F32s_v2, Standard_F48s_v2, Standard_F64s_v2, Standard_F72s_v2, Standard_D4s_v3, Standard_D8s_v3, Standard_D16s_v3, Standard_D32s_v3, Standard_D48s_v3, Standard_D64s_v3, Standard_E4s_v3, Standard_E8s_v3, Standard_E16s_v3, Standard_E20s_v3, Standard_E32s_v3, Standard_E48s_v3, Standard_E64s_v3, Standard_GS2, Standard_GS3, Standard_GS4, Standard_GS5
AzureProviderSettings
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
resourceGroupName |
||||
region |
||||
aksClusterName |
||||
dnsPrefix |
||||
defaultNodePoolName |
||||
tags |
Map of [string] |
|||
vNetCidr |
||||
vNetName |
||||
storageAccountName |
||||
configContainerName |
||||
importContainerName |
||||
availabilityZones |
List of [string] |
|||
azCount |
||||
deploymentName |
||||
msiName |
||||
tenantId |
||||
subscriptionId |
BucketRole
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
bucketName |
X |
Bucket Name |
||
bucketAccess |
X |
Set of BucketRoleTypes |
BucketStats
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
status |
X |
|||
totalCount |
X |
|||
unhealthyCount |
X |
|||
healthStats |
X |
Map of [string] |
Cloud
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
X |
uuid |
||
name |
X |
|||
tenantId |
X |
uuid |
||
status |
X |
|||
provider |
X |
|||
createdAt |
X |
date-time |
||
updatedAt |
date-time |
|||
preflightStartedAt |
date-time |
|||
preflightFailedAt |
date-time |
|||
preflightCompletedAt |
date-time |
|||
bootstrappedAt |
date-time |
|||
deployedAt |
date-time |
|||
destroyedAt |
date-time |
|||
providerSettings |
X |
|||
version |
X |
CloudProviderSettings
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
resourceGroupName |
||||
region |
||||
aksClusterName |
||||
dnsPrefix |
||||
defaultNodePoolName |
||||
tags |
Map of [string] |
|||
vNetCidr |
||||
vNetName |
||||
storageAccountName |
||||
configContainerName |
||||
importContainerName |
||||
availabilityZones |
List of [string] |
|||
azCount |
||||
deploymentName |
||||
msiName |
||||
tenantId |
||||
subscriptionId |
||||
bucket |
||||
supportBucket |
||||
accountId |
||||
vpcCidr |
||||
vpcId |
||||
stackId |
||||
privateSubnets |
List of [string] |
|||
availabilityZone |
List of [string] |
|||
lastRotated |
date-time |
CloudSummary
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
X |
uuid |
||
name |
X |
|||
status |
X |
|||
provider |
X |
|||
region |
X |
|||
virtualNetworkID |
X |
|||
virtualNetworkCIDR |
X |
CloudVersion
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
name |
X |
|||
components |
X |
Map of [string] |
Cluster
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
X |
|||
name |
X |
|||
tenantId |
X |
|||
cloudId |
X |
|||
projectId |
X |
|||
status |
X |
|||
resourceIdentifier |
X |
Resource identifier name linked with the Cloud Provider |
||
createdAt |
date-time |
|||
updatedAt |
date-time |
|||
deployedAt |
date-time |
|||
version |
||||
endpointsURL |
List of [string] |
|||
privateEndpointURL |
List of [string] |
|||
endpointsSrv |
||||
privateEndpointsSrv |
ClusterHealth
Description
-
healthy- denotes that the resource is in a healthy state. -
unhealthy- denotes that the resource is in an uhealthy state. -
degraded- is reported for the overall health of a cluster or overall health for all nodes if all unhealthy nodes in the cluster are failed over. -
failedOver- enotes that a couchbase server node failed over to a new pod. This status is attached only to a node. -
inactiveFailed- is the value of the cluster membership as reported for a couchbase server node when it is in failed over state. -
N/A- is the value of the cluster membership if we are unable to determine the health of the cluster
ClusterHealthResponse
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
status |
X |
|||
health |
X |
|||
bucketStats |
||||
nodeStats |
ClusterStatus
Allowable Values
draft, needs_deploy, job_scheduled, deploying, deploy_failed, deploy_succeeded, ready, destroying, destroy_failed, destroy_succeeded, metrics_failed, preflight_started, preflight_failed, preflight_succeeded, management_blocked, upgrading
Description
-
draft- indicates that all fields under database model are mutable. -
needs_deploy- indicates that the new configuration changes have not been applied to the cluster -
job_scheduled- indicates that the new configuration changes have been scheduled to be applied. -
deploying- indicates that database is currently being deployed/new configurations being applied. -
deploy_failed- indicates that the last deployment failed. -
deploy_succeeded- indicates that the last deployment succeeded. -
ready- indicates that the database is ready. -
destroying- indicates that the database is being destroyed. -
destroy_failed- indicates that the database destroy job failed. -
destroy_succeeded- indicates that the database destroy job succeeded. -
metrics_failed- indicates that the database is not serving metrics. -
preflight_started- indicates a preflight check has started on the database -
preflight_failed- indicates a preflight check has failed on the database -
preflight_succeeded- indicates a preflight check has succeeded on the database -
management_blocked- indicates the IAM credentiald for the cloud hosting the databse have been deleted. -
upgrading- indicates the database is being upgrading.
ClusterSummary
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
X |
uuid |
||
name |
X |
|||
tenantId |
X |
uuid |
||
cloudId |
X |
uuid |
||
projectId |
X |
uuid |
||
services |
X |
List of CouchbaseServices |
||
nodes |
X |
ClusterVersion
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
name |
X |
|||
components |
X |
Map of [string] |
CouchbaseBucketSpec
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
name |
X |
|||
memoryQuota |
X |
|||
replicas |
||||
conflictResolution |
CreateClusterRequest
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
name |
X |
|||
cloudId |
X |
uuid |
||
projectId |
X |
uuid |
||
servers |
List of Server |
|||
supportPackage |
||||
version |
CreateDatabaseUserRequest
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
userId |
Organization user which is assigned to the database user. |
uuid |
||
username |
X |
|||
password |
X |
|||
buckets |
List of BucketRole |
|||
allBucketsAccess |
CursorPages
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
page |
Current page starting from 1. |
|||
next |
Next page number, it is not set on the last page. |
|||
previous |
Previous page number, it is not set on the first page. |
|||
last |
Last page number. |
|||
perPage |
How many items are displayed in the page. |
|||
totalItems |
X |
Total items found by the given query. |
DeleteBucketRequest
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
name |
X |
The name of the bucket to be deleted |
ListBucketItem
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
name |
X |
|||
memoryQuota |
X |
|||
replicas |
X |
|||
conflictResolution |
X |
|||
status |
X |
ListCloudsResponse
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
cursor |
X |
|||
data |
X |
List of CloudSummary |
ListClustersResponse
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
cursor |
X |
|||
data |
X |
List of ClusterSummary |
ListDatabaseUsersResponseItem
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
userId |
Organization user ID Database user is attached to |
uuid |
||
username |
X |
|||
access |
X |
List of BucketRole |
ListProjectsResponse
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
cursor |
X |
|||
data |
X |
List of Project |
ListUsersResponse
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
cursor |
X |
|||
data |
X |
List of ListUsersResponseItem |
NodeStats
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
status |
X |
|||
totalCount |
X |
|||
failedOverCount |
X |
|||
unhealthyCount |
X |
|||
serviceStats |
X |
List of ServiceStats |
Project
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
X |
uuid |
||
name |
X |
|||
tenantId |
X |
uuid |
||
createdAt |
X |
Creation date and time |
date-time |
Server
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
size |
X |
|||
services |
X |
List of CouchbaseServices |
||
aws |
||||
azure |
ServiceStats
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
services |
X |
List of [string] |
||
nodeName |
X |
|||
status |
X |
UpdateDatabaseUserRequest
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
userId |
Organization user to update which is assigned to the database user. |
uuid |
||
username |
||||
password |
||||
buckets |
List of BucketRole |
|||
allBucketsAccess |