Couchbase Logs API

openapi: 3.1.0
info:
  title: Couchbase Analytics Service REST Allowed CIDRs Logs 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: 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 credentials.
externalDocs:
  description: Couchbase Analytics Service REST API Documentation
  url: https://docs.couchbase.com/server/current/analytics/rest-analytics.html