Couchbase Monitoring API

Endpoints for monitoring App Services health and performance.

Operations 2

GET /_expvar Get runtime statistics #
GET /_status Get server status #

Documentation

Specifications

Other Resources

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-monitoring-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.

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

OpenAPI Specification

couchbase-monitoring-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Couchbase Monitoring API
  contact:
    name: Couchbase Support
    url: https://support.couchbase.com
  termsOfService: https://www.couchbase.com/terms-of-use
  version: '1.0'
  description: 'Operations tagged Monitoring across 2 of this provider''s published API definitions: couchbase-capella-app-services-admin-api-openapi.yml, couchbase-sync-gateway-admin-rest-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{appEndpoint}:4985
  description: Capella App Services Admin endpoint
  variables:
    appEndpoint:
      default: example.apps.cloud.couchbase.com
      description: The App Services admin endpoint URL
- url: https://localhost:4985
  description: Sync Gateway Admin REST API (default port)
security:
- basicAuth: []
tags:
- name: Monitoring
  description: Endpoints for monitoring App Services health and performance.
paths:
  /_expvar:
    get:
      operationId: getExpvar
      summary: Get runtime statistics
      description: Returns runtime expvar statistics for the Sync Gateway instance including memory usage, goroutine counts, and database statistics.
      tags:
      - Monitoring
      responses:
        '200':
          description: Successful retrieval of runtime statistics
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized access
    servers:
    - url: https://{appEndpoint}:4985
      description: Capella App Services Admin endpoint
      variables:
        appEndpoint:
          default: example.apps.cloud.couchbase.com
          description: The App Services admin endpoint URL
  /_status:
    get:
      operationId: getStatus
      summary: Get server status
      description: Returns the status of the Sync Gateway server including version information and database states.
      tags:
      - Monitoring
      responses:
        '200':
          description: Successful retrieval of server status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerStatus'
        '401':
          description: Unauthorized access
    servers:
    - url: https://{appEndpoint}:4985
      description: Capella App Services Admin endpoint
      variables:
        appEndpoint:
          default: example.apps.cloud.couchbase.com
          description: The App Services admin endpoint URL
components:
  schemas:
    ServerStatus:
      type: object
      description: Sync Gateway server status
      properties:
        couchdb:
          type: string
          description: CouchDB compatibility string
        vendor:
          type: object
          description: Vendor information
          properties:
            name:
              type: string
              description: Vendor name
            version:
              type: string
              description: Sync Gateway version
        version:
          type: string
          description: Full version string
        databases:
          type: object
          description: Database states
          additionalProperties:
            type: object
            properties:
              state:
                type: string
                description: Database state
                enum:
                - Online
                - Offline
              name:
                type: string
                description: Database name
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using App Services admin credentials.
x-refined-from:
- couchbase-capella-app-services-admin-api-openapi.yml
- couchbase-sync-gateway-admin-rest-api-openapi.yml