Couchbase Cluster API

openapi: 3.1.0
info:
  title: Couchbase Analytics Service REST Allowed CIDRs Cluster 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: Cluster
  description: Endpoints for managing cluster-level backup configuration.
paths:
  /api/v1/cluster/self:
    get:
      operationId: getBackupClusterInfo
      summary: Get backup cluster information
      description: Returns information about the current cluster from the perspective of the Backup Service, including the list of repositories and plans.
      tags:
      - Cluster
      responses:
        '200':
          description: Successful retrieval of cluster backup information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupClusterInfo'
        '401':
          description: Unauthorized access
  /pools:
    get:
      operationId: getPools
      summary: Get cluster information
      description: Returns basic information about the cluster including the list of pools, UUID, and implementation version.
      tags:
      - Cluster
      responses:
        '200':
          description: Successful retrieval of cluster pool information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pools'
        '401':
          description: Unauthorized access
  /pools/default:
    get:
      operationId: getPoolDefault
      summary: Get default pool details
      description: Returns detailed information about the default pool including cluster name, storage totals, RAM quotas, node list, and bucket information.
      tags:
      - Cluster
      responses:
        '200':
          description: Successful retrieval of default pool details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PoolDetails'
        '401':
          description: Unauthorized access
components:
  schemas:
    Pools:
      type: object
      description: Cluster pool information
      properties:
        isAdminCreds:
          type: boolean
          description: Whether admin credentials are being used
        isROAdminCreds:
          type: boolean
          description: Whether read-only admin credentials are being used
        isEnterprise:
          type: boolean
          description: Whether this is an Enterprise Edition cluster
        implementationVersion:
          type: string
          description: The version of the Couchbase Server implementation
        uuid:
          type: string
          description: The unique identifier for the cluster
        pools:
          type: array
          description: List of available pools
          items:
            type: object
            properties:
              name:
                type: string
                description: Pool name
              uri:
                type: string
                description: URI to access pool details
              streamingUri:
                type: string
                description: URI for streaming pool updates
    Node:
      type: object
      description: Information about a cluster node
      properties:
        hostname:
          type: string
          description: Node hostname and port
        status:
          type: string
          description: Node status
          enum:
          - healthy
          - unhealthy
          - warmup
        clusterMembership:
          type: string
          description: Cluster membership status
          enum:
          - active
          - inactiveAdded
          - inactiveFailed
        services:
          type: array
          description: List of services running on the node
          items:
            type: string
            enum:
            - kv
            - n1ql
            - index
            - fts
            - cbas
            - eventing
            - backup
        os:
          type: string
          description: Operating system of the node
        version:
          type: string
          description: Couchbase Server version on the node
        memoryTotal:
          type: integer
          description: Total memory on the node in bytes
        memoryFree:
          type: integer
          description: Free memory on the node in bytes
    BackupClusterInfo:
      type: object
      description: Cluster backup information
      properties:
        name:
          type: string
          description: Cluster name
        repositories:
          type: array
          description: List of repository names
          items:
            type: string
        plans:
          type: array
          description: List of plan names
          items:
            type: string
    PoolDetails:
      type: object
      description: Detailed information about the default pool
      properties:
        name:
          type: string
          description: Name of the pool
        clusterName:
          type: string
          description: Human-readable cluster name
        nodes:
          type: array
          description: List of nodes in the cluster
          items:
            $ref: '#/components/schemas/Node'
        storageTotals:
          type: object
          description: Aggregate storage statistics
          properties:
            ram:
              type: object
              properties:
                total:
                  type: integer
                  description: Total RAM in bytes
                used:
                  type: integer
                  description: Used RAM in bytes
            hdd:
              type: object
              properties:
                total:
                  type: integer
                  description: Total disk space in bytes
                used:
                  type: integer
                  description: Used disk space in bytes
        rebalanceStatus:
          type: string
          description: Current rebalance status
  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