How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Couchbase Clusters API

Endpoints for provisioning, managing, and scaling Capella database clusters.

Couchbase Clusters API is one of 54 APIs that Couchbase publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Cluster. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.2.0, at version 4.0.

Requests are made against a single base URL, https://cloudapi.cloud.couchbase.com.

5 operations 2 paths 6 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.0
Base URL
https://localhost:8091
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Couchbase Clusters API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token authentication using a Capella API key secret.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Clusters 5

Endpoints for provisioning, managing, and scaling Capella database clusters.

GET
/v4/organizations/{organizationId}/projects/{projectId}/clusters
List clusters
listClusters 4 params → 200401429
POST
/v4/organizations/{organizationId}/projects/{projectId}/clusters
Create a cluster
createCluster 2 params body → 202400401429
GET
/v4/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId}
Get cluster details
getCluster 3 params → 200401404429
PUT
/v4/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId}
Update a cluster
updateCluster 3 params body → 202400401404429
DELETE
/v4/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId}
Delete a cluster
deleteCluster 3 params → 202401404429

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Cluster (11 properties), ClusterCreateRequest (7 properties), AuditInfo (5 properties), ClusterUpdateRequest (4 properties). Each schema is shown below with its type and property counts.

ServiceGroup
object
Service group within a cluster
3 properties
PaginatedResponse
object
Paginated response wrapper
2 properties
AuditInfo
object
Audit timestamps
5 properties
ClusterCreateRequest
object
Request to create a new cluster
7 properties 5 required
ClusterUpdateRequest
object
Request to update an existing cluster
4 properties
Cluster
object
Capella database cluster
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

couchbase-clusters-api-openapi.yml Raw ↑

Other APIs Couchbase publishes across the network.

Couchbase Allowed CIDRs API
Couchbase Analytics Admin API
Couchbase Analytics Configuration API
Couchbase Analytics Library API
Couchbase Analytics Query API
Couchbase Analytics Settings API
Couchbase API Keys API
Couchbase Authentication API
Couchbase Buckets API
Couchbase Changes API
Couchbase Cluster API
Couchbase Cluster References API
Where this information came from

This is an independent, third-party profile of Couchbase Clusters API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.