Couchbase

Couchbase Index Service API

Endpoints for managing the Global Secondary Index service.

Documentation GitHub OpenAPI

Operations 2

GET /settings/indexes Get index service settings #

POST /settings/indexes Update index service settings #

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-index-service-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 Index Service 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: Index Service
  description: Endpoints for managing the Global Secondary Index service.
paths:
  /settings/indexes:
    get:
      operationId: getIndexSettings
      summary: Get index service settings
      description: Returns the current configuration settings for the Index service.
      tags:
      - Index Service
      responses:
        '200':
          description: Successful retrieval of index settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndexSettings'
        '401':
          description: Unauthorized access
    post:
      operationId: updateIndexSettings
      summary: Update index service settings
      description: Updates the configuration settings for the Index service including storage mode and memory allocation.
      tags:
      - Index Service
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/IndexSettings'
      responses:
        '200':
          description: Index settings updated successfully
        '400':
          description: Invalid index settings
        '401':
          description: Unauthorized access
components:
  schemas:
    IndexSettings:
      type: object
      description: Index service configuration
      properties:
        storageMode:
          type: string
          description: Index storage mode
          enum:
          - plasma
          - memory_optimized
          - forestdb
        indexerThreads:
          type: integer
          description: Number of indexer threads
        memorySnapshotInterval:
          type: integer
          description: Memory snapshot interval in milliseconds
        stableSnapshotInterval:
          type: integer
          description: Stable snapshot interval in milliseconds
        logLevel:
          type: string
          description: Log level for the index service
          enum:
          - silent
          - fatal
          - error
          - warn
          - info
          - verbose
          - timing
          - debug
          - trace
  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