Couchbase Analytics Settings API

openapi: 3.1.0
info:
  title: Couchbase Analytics Service REST Allowed CIDRs Analytics Settings 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: Analytics Settings
  description: Endpoints for configuring Analytics service settings.
paths:
  /settings/analytics:
    get:
      operationId: getAnalyticsSettings
      summary: Get analytics settings
      description: Returns the current cluster-level Analytics service settings.
      tags:
      - Analytics Settings
      responses:
        '200':
          description: Successful retrieval of analytics settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsSettings'
        '401':
          description: Unauthorized access
    post:
      operationId: updateAnalyticsSettings
      summary: Update analytics settings
      description: Updates the cluster-level Analytics service settings.
      tags:
      - Analytics Settings
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AnalyticsSettings'
      responses:
        '200':
          description: Analytics settings updated successfully
        '400':
          description: Invalid settings
        '401':
          description: Unauthorized access
components:
  schemas:
    AnalyticsSettings:
      type: object
      description: Cluster-level analytics settings
      properties:
        numReplicas:
          type: integer
          description: Number of Analytics replicas
          minimum: 0
          maximum: 3
  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