Couchbase Monitoring API

openapi: 3.1.0
info:
  title: Couchbase Analytics Service REST Allowed CIDRs Monitoring API
  description: The Couchbase Analytics Service REST API provides access to the Analytics service for running complex analytical queries on operational data without impacting performance of key-value operations. It supports SQL++ queries for analytics, management of links to external data sources, and configuration of user-defined libraries. The service enables real-time analytics on JSON data alongside transactional workloads.
  version: '7.6'
  contact:
    name: Couchbase Support
    url: https://support.couchbase.com
  termsOfService: https://www.couchbase.com/terms-of-use
servers:
- url: https://localhost:8095
  description: Analytics Service (default port)
- url: https://localhost:18095
  description: Analytics Service (SSL)
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
  /_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
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 Couchbase Server credentials.
externalDocs:
  description: Couchbase Analytics Service REST API Documentation
  url: https://docs.couchbase.com/server/current/analytics/rest-analytics.html