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 Buckets API

Endpoints for managing buckets within Capella clusters.

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

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

This API exposes 10 operations across 4 paths, and defines 6 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 3 base URLs: https://cloudapi.cloud.couchbase.com, https://localhost:8091, https://localhost:18091.

10 operations 4 paths 6 schemas 2 DELETE4 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

Couchbase Buckets API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP basic authentication (basicAuth).

  • bearerAuth — Bearer token authentication using a Capella API key secret.
  • basicAuth — HTTP Basic Authentication using Couchbase Server administrator credentials.

Paths & Operations 10

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

Buckets 10

Endpoints for managing buckets within Capella clusters.

GET
/v4/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId}/buckets
List buckets in a cluster
listCapellaBuckets 3 params → 200401404429
POST
/v4/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId}/buckets
Create a bucket
createCapellaBucket 3 params body → 201400401404429
GET
/v4/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId}/buckets/{bucketId}
Get bucket details
getCapellaBucket 4 params → 200401404429
PUT
/v4/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId}/buckets/{bucketId}
Update a bucket
updateCapellaBucket 4 params body → 204400401404429
DELETE
/v4/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId}/buckets/{bucketId}
Delete a bucket
deleteCapellaBucket 4 params → 204401404429
GET
/pools/default/buckets
List all buckets
listBuckets → 200401
POST
/pools/default/buckets
Create a new bucket
createBucket body → 202400401
GET
/pools/default/buckets/{bucketName}
Get bucket details
getBucket 1 param → 200401404
POST
/pools/default/buckets/{bucketName}
Update bucket settings
updateBucket 1 param body → 200400401404
DELETE
/pools/default/buckets/{bucketName}
Delete a bucket
deleteBucket 1 param → 200401404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Bucket (10 properties), CapellaBucket (10 properties), CapellaBucketCreateRequest (8 properties), BucketCreateRequest (7 properties). Each schema is shown below with its type and property counts.

CapellaBucket
object
Bucket in a Capella cluster
10 properties
CapellaBucketUpdateRequest
object
Request to update a Capella bucket
5 properties
CapellaBucketCreateRequest
object
Request to create a Capella bucket
8 properties 2 required
BucketCreateRequest
object
Request body for creating a new bucket
7 properties 2 required
BucketUpdateRequest
object
Request body for updating a bucket
3 properties
Bucket
object
Bucket configuration and statistics
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

couchbase-buckets-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 Changes API
Couchbase Cluster API
Couchbase Cluster References API
Couchbase Clusters API
Where this information came from

This is an independent, third-party profile of Couchbase Buckets 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.