openapi: 3.1.0
info:
  title: Couchbase Analytics Service REST Allowed CIDRs Configuration 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: Configuration
  description: Endpoints for configuring Eventing Service settings.
paths:
  /api/v1/config:
    get:
      operationId: getEventingConfig
      summary: Get Eventing Service configuration
      description: Returns the current configuration settings for the Eventing Service.
      tags:
      - Configuration
      responses:
        '200':
          description: Successful retrieval of Eventing configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventingConfig'
        '401':
          description: Unauthorized access
    post:
      operationId: updateEventingConfig
      summary: Update Eventing Service configuration
      description: Updates the configuration settings for the Eventing Service.
      tags:
      - Configuration
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventingConfig'
      responses:
        '200':
          description: Configuration updated successfully
        '400':
          description: Invalid configuration
        '401':
          description: Unauthorized access
components:
  schemas:
    EventingConfig:
      type: object
      description: Eventing Service configuration
      properties:
        enable_debugger:
          type: boolean
          description: Whether the debugger is enabled
        ram_quota:
          type: integer
          description: RAM quota for the Eventing service in megabytes
  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