Couchbase

Couchbase Database API

Endpoints for retrieving database information.

Documentation GitHub OpenAPI

Operations 1

GET /{db} Get database 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-database-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 Database API
  contact:
    name: Couchbase Support
    url: https://support.couchbase.com
  termsOfService: https://www.couchbase.com/terms-of-use
  version: '1.0'
  description: 'Operations tagged Database across 2 of this provider''s published API definitions: couchbase-capella-app-services-public-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://{appEndpoint}
  description: Capella App Services endpoint
  variables:
    appEndpoint:
      default: example.apps.cloud.couchbase.com
      description: The App Services endpoint URL
- url: https://localhost:4984
  description: Sync Gateway Public REST API (default port)
security:
- basicAuth: []
- sessionAuth: []
tags:
- name: Database
  description: Endpoints for retrieving database information.
paths:
  /{db}:
    get:
      operationId: getDatabaseInfo
      summary: Get database information
      description: Returns information about the specified database including its name, update sequence, and instance start time.
      tags:
      - Database
      parameters:
      - $ref: '#/components/parameters/db'
      responses:
        '200':
          description: Successful retrieval of database information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseInfo'
        '401':
          description: Unauthorized access
        '404':
          description: Database not found
    servers:
    - url: https://{appEndpoint}
      description: Capella App Services endpoint
      variables:
        appEndpoint:
          default: example.apps.cloud.couchbase.com
          description: The App Services endpoint URL
components:
  parameters:
    db:
      name: db
      in: path
      required: true
      description: The name of the database (keyspace)
      schema:
        type: string
    db_2:
      name: db
      in: path
      required: true
      description: The database name
      schema:
        type: string
  schemas:
    DatabaseInfo:
      type: object
      description: Database information
      properties:
        db_name:
          type: string
          description: Name of the database
        update_seq:
          type: integer
          description: Current update sequence number
        committed_update_seq:
          type: integer
          description: Committed update sequence number
        instance_start_time:
          type: integer
          description: Instance start time in microseconds since epoch
        compact_running:
          type: boolean
          description: Whether compaction is currently running
        state:
          type: string
          description: Database state
          enum:
          - Online
          - Offline
    DatabaseInfo_2:
      type: object
      description: Database information
      properties:
        db_name:
          type: string
          description: Database name
        update_seq:
          type: integer
          description: Current update sequence number
        committed_update_seq:
          type: integer
          description: Committed update sequence
        instance_start_time:
          type: integer
          description: Instance start time in microseconds
        compact_running:
          type: boolean
          description: Whether compaction is running
        state:
          type: string
          description: Database state
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using Sync Gateway user credentials.
    sessionAuth:
      type: apiKey
      in: cookie
      name: SyncGatewaySession
      description: Session cookie authentication obtained from the _session endpoint.
x-refined-from:
- couchbase-capella-app-services-public-api-openapi.yml
- couchbase-sync-gateway-public-rest-api-openapi.yml