Couchbase Documents API
Endpoints for creating, reading, updating, and deleting documents.
Couchbase Documents API is one of 54 APIs that Couchbase publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 6 operations across 4 paths, and defines 6 schemas. It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 2 base URLs: https://{appEndpoint}, https://localhost:4984.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Couchbase Documents API declares
2 security schemes
for authenticating requests.
It accepts HTTP basic authentication (basicAuth).
An API key is passed in the cookie as SyncGatewaySession (sessionAuth).
By default, every request must be authenticated.
basicAuth— HTTP Basic Authentication using Sync Gateway user credentials.sessionAuth— Session cookie authentication obtained from the session endpoint.
Paths & Operations 6
Across 4 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Endpoints for creating, reading, updating, and deleting documents.
Schemas 6
The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Document (5 properties), Document_2 (4 properties), DocumentWriteResponse (3 properties), AllDocsResponse_2 (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Couchbase 12
Other APIs Couchbase publishes across the network.
This is an independent, third-party profile of Couchbase Documents 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.