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 Scopes and Collections API

Endpoints for managing scopes and collections within Capella buckets.

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

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

This API exposes 5 operations across 3 paths, and defines 2 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.

5 operations 3 paths 2 schemas 2 GET3 POST

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 Scopes and Collections 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 5

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

Scopes and Collections 5

Endpoints for managing scopes and collections within Capella buckets.

GET
/v4/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId}/buckets/{bucketId}/scopes
List scopes in a bucket
listCapellaScopes 4 params → 200401404429
POST
/v4/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId}/buckets/{bucketId}/scopes
Create a scope
createCapellaScope 4 params body → 201400401429
GET
/pools/default/buckets/{bucketName}/scopes
List scopes in a bucket
listScopes 1 param → 200401404
POST
/pools/default/buckets/{bucketName}/scopes
Create a scope
createScope 1 param body → 200400401404
POST
/pools/default/buckets/{bucketName}/scopes/{scopeName}/collections
Create a collection
createCollection 2 params body → 200400401404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are ScopesList (2 properties), CapellaScope (2 properties). Each schema is shown below with its type and property counts.

CapellaScope
object
Scope within a Capella bucket
2 properties
ScopesList
object
List of scopes in a bucket
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

couchbase-scopes-and-collections-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 Scopes and Collections 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.