Couchbase Logs API

Endpoints for collecting and managing diagnostic logs.

Operations 2

GET /diag Get diagnostic information #
POST /controller/startLogsCollection Start log collection #

Documentation

Specifications

Other Resources

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

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

couchbase-logs-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Couchbase Server REST Logs 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: Logs
  description: Endpoints for collecting and managing diagnostic logs.
paths:
  /diag:
    get:
      operationId: getDiagnostics
      summary: Get diagnostic information
      description: Returns diagnostic information for the cluster including logs and system statistics useful for troubleshooting.
      tags:
      - Logs
      responses:
        '200':
          description: Successful retrieval of diagnostic information
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized access
  /controller/startLogsCollection:
    post:
      operationId: startLogCollection
      summary: Start log collection
      description: Initiates the collection of diagnostic logs across cluster nodes for analysis and troubleshooting.
      tags:
      - Logs
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                nodes:
                  type: string
                  description: Comma-separated list of node addresses to collect logs from
                logRedactionLevel:
                  type: string
                  enum:
                  - none
                  - partial
                  description: Level of log redaction for sensitive data
      responses:
        '200':
          description: Log collection started successfully
        '401':
          description: Unauthorized access
components:
  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