Couchbase

Couchbase Search Monitoring API

Endpoints for monitoring search index statistics and service status.

Documentation GitHub OpenAPI

Operations 4

GET /api/index/{indexName}/count Get document count for a search index #

GET /api/stats Get search service statistics #

GET /api/stats/index/{indexName} Get statistics for a search index #

GET /api/nsstats Get namespace-level search statistics #

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

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 Search Service REST Search Monitoring API
  description: The Couchbase Search Service REST API allows developers to create, manage, and query Full Text Indexes on Couchbase Server. It supports full-text search queries with features like fuzzy matching, faceted search, highlighting, and geospatial queries. The API provides endpoints for index definition, index management, and executing search queries across JSON documents stored in Couchbase buckets.
  version: '7.6'
  contact:
    name: Couchbase Support
    url: https://support.couchbase.com
  termsOfService: https://www.couchbase.com/terms-of-use
servers:
- url: https://localhost:8094
  description: Search Service (default port)
- url: https://localhost:18094
  description: Search Service (SSL)
security:
- basicAuth: []
tags:
- name: Search Monitoring
  description: Endpoints for monitoring search index statistics and service status.
paths:
  /api/index/{indexName}/count:
    get:
      operationId: getSearchIndexDocCount
      summary: Get document count for a search index
      description: Returns the number of documents that have been indexed by the specified Full Text Search index.
      tags:
      - Search Monitoring
      parameters:
      - $ref: '#/components/parameters/indexName'
      responses:
        '200':
          description: Successful retrieval of document count
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: Response status
                  count:
                    type: integer
                    description: Number of indexed documents
        '401':
          description: Unauthorized access
        '404':
          description: Index not found
  /api/stats:
    get:
      operationId: getSearchStats
      summary: Get search service statistics
      description: Returns aggregate statistics for the Search service and all indexes on the node.
      tags:
      - Search Monitoring
      responses:
        '200':
          description: Successful retrieval of search statistics
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          description: Unauthorized access
  /api/stats/index/{indexName}:
    get:
      operationId: getSearchIndexStats
      summary: Get statistics for a search index
      description: Returns detailed statistics for a specific search index including document count, mutation throughput, and query performance metrics.
      tags:
      - Search Monitoring
      parameters:
      - $ref: '#/components/parameters/indexName'
      responses:
        '200':
          description: Successful retrieval of index statistics
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          description: Unauthorized access
        '404':
          description: Index not found
  /api/nsstats:
    get:
      operationId: getSearchNamespaceStats
      summary: Get namespace-level search statistics
      description: Returns namespace-level statistics for the Search service that can be consumed by monitoring systems like Prometheus.
      tags:
      - Search Monitoring
      responses:
        '200':
          description: Successful retrieval of namespace statistics
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          description: Unauthorized access
components:
  parameters:
    indexName:
      name: indexName
      in: path
      required: true
      description: The name of the Full Text Search index
      schema:
        type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using Couchbase Server credentials.
externalDocs:
  description: Couchbase Search Service REST API Documentation
  url: https://docs.couchbase.com/server/current/rest-api/rest-fts.html