Couchbase

Couchbase Server Groups API

Endpoints for managing server groups for rack-zone awareness.

Documentation GitHub OpenAPI

Operations 2

GET /pools/default/serverGroups List server groups #

POST /pools/default/serverGroups Create a server group #

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-groups-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 REST Server Groups API
  description: The Couchbase Server REST API provides programmatic access to manage and configure Couchbase Server clusters. It includes endpoints for cluster management, bucket operations, node administration, security settings, and server configuration. The API enables automation of deployment, monitoring, and maintenance tasks for Couchbase Server instances across distributed environments.
  version: '7.6'
  contact:
    name: Couchbase Support
    url: https://support.couchbase.com
  termsOfService: https://www.couchbase.com/terms-of-use
servers:
- url: https://localhost:8091
  description: Couchbase Server (default port)
- url: https://localhost:18091
  description: Couchbase Server (SSL)
security:
- basicAuth: []
tags:
- name: Server Groups
  description: Endpoints for managing server groups for rack-zone awareness.
paths:
  /pools/default/serverGroups:
    get:
      operationId: listServerGroups
      summary: List server groups
      description: Returns the list of server groups and their member nodes for rack-zone awareness configuration.
      tags:
      - Server Groups
      responses:
        '200':
          description: Successful retrieval of server groups
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerGroups'
        '401':
          description: Unauthorized access
    post:
      operationId: createServerGroup
      summary: Create a server group
      description: Creates a new server group for rack-zone awareness.
      tags:
      - Server Groups
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - name
              properties:
                name:
                  type: string
                  description: The name of the server group
      responses:
        '200':
          description: Server group created successfully
        '400':
          description: Invalid server group name
        '401':
          description: Unauthorized access
components:
  schemas:
    ServerGroups:
      type: object
      description: Server groups configuration
      properties:
        groups:
          type: array
          description: List of server groups
          items:
            type: object
            properties:
              name:
                type: string
                description: Name of the server group
              uri:
                type: string
                description: URI for the server group
              nodes:
                type: array
                description: Nodes in the server group
                items:
                  $ref: '#/components/schemas/Node'
    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
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using Couchbase Server administrator credentials.
externalDocs:
  description: Couchbase Server REST API Documentation
  url: https://docs.couchbase.com/server/current/rest-api/rest-intro.html