Couchbase

Couchbase Server API

Endpoints for managing the Sync Gateway server instance.

Documentation GitHub OpenAPI

Operations 3

GET /_all_dbs List all databases #

GET /_config Get server configuration #

GET / Get server information #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/couchbase-server-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Couchbase Server API
  version: '3.1'
  contact:
    name: Couchbase Support
    url: https://support.couchbase.com
  termsOfService: https://www.couchbase.com/terms-of-use
  description: 'Operations tagged Server across 2 of this provider''s published API definitions: couchbase-sync-gateway-admin-rest-api-openapi.yml, couchbase-sync-gateway-public-rest-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://localhost:4985
  description: Sync Gateway Admin REST API (default port)
- url: https://localhost:4984
  description: Sync Gateway Public REST API (default port)
tags:
- name: Server
  description: Endpoints for managing the Sync Gateway server instance.
paths:
  /_all_dbs:
    get:
      operationId: listDatabases
      summary: List all databases
      description: Returns the names of all databases configured on the Sync Gateway instance.
      tags:
      - Server
      responses:
        '200':
          description: Successful retrieval of database list
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        '401':
          description: Unauthorized access
      security:
      - basicAuth: []
    servers:
    - url: https://localhost:4985
      description: Sync Gateway Admin REST API (default port)
  /_config:
    get:
      operationId: getServerConfig
      summary: Get server configuration
      description: Returns the complete Sync Gateway server configuration.
      tags:
      - Server
      responses:
        '200':
          description: Successful retrieval of server configuration
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized access
      security:
      - basicAuth: []
    servers:
    - url: https://localhost:4985
      description: Sync Gateway Admin REST API (default port)
  /:
    get:
      operationId: getServerInfo
      summary: Get server information
      description: Returns information about the Sync Gateway server instance.
      tags:
      - Server
      security: []
      responses:
        '200':
          description: Successful retrieval of server information
          content:
            application/json:
              schema:
                type: object
                properties:
                  couchdb:
                    type: string
                    description: CouchDB compatibility string
                  vendor:
                    type: object
                    properties:
                      name:
                        type: string
                      version:
                        type: string
                  version:
                    type: string
                    description: Sync Gateway version
    servers:
    - url: https://localhost:4984
      description: Sync Gateway Public REST API (default port)
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication with admin credentials or RBAC user with appropriate roles.
    sessionAuth:
      type: apiKey
      in: cookie
      name: SyncGatewaySession
      description: Session cookie from the _session endpoint.
x-refined-from:
- couchbase-sync-gateway-admin-rest-api-openapi.yml
- couchbase-sync-gateway-public-rest-api-openapi.yml