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 Database Administration API

Endpoints for managing database configurations within App Services.

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

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

This API exposes 7 operations across 5 paths, and defines 1 schema. It is described by OpenAPI 3.2.0, at version 3.0.

Requests are made against a single base URL, https://{appEndpoint}:4985.

7 operations 5 paths 1 schemas 2 GET3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Couchbase Database Administration API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic Authentication using App Services admin credentials.

Paths & Operations 7

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

Database Administration 7

Endpoints for managing database configurations within App Services.

GET
/{db}/_config
Get database configuration
getDatabaseConfig 1 param → 200401404
PUT
/{db}/_config
Update database configuration
updateDatabaseConfig 1 param body → 200400401404
GET
/{db}/_config/sync
Get sync function
getSyncFunction 1 param → 200401404
PUT
/{db}/_config/sync
Update sync function
updateSyncFunction 1 param body → 200400401404
POST
/{db}/_offline
Take database offline
takeDatabaseOffline 1 param → 200401404
POST
/{db}/_online
Bring database online
bringDatabaseOnline 1 param body → 200401404
POST
/{db}/_resync
Resync database
resyncDatabase 1 param → 200401404

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is DatabaseConfig (9 properties). Each schema is shown below with its type and property counts.

DatabaseConfig
object
Database configuration
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

couchbase-database-administration-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 Database Administration 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.