Couchbase Index Service API

openapi: 3.1.0
info:
  title: Couchbase Analytics Service REST Allowed CIDRs Index Service 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: Index Service
  description: Endpoints for managing the Global Secondary Index service.
paths:
  /settings/indexes:
    get:
      operationId: getIndexSettings
      summary: Get index service settings
      description: Returns the current configuration settings for the Index service.
      tags:
      - Index Service
      responses:
        '200':
          description: Successful retrieval of index settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndexSettings'
        '401':
          description: Unauthorized access
    post:
      operationId: updateIndexSettings
      summary: Update index service settings
      description: Updates the configuration settings for the Index service including storage mode and memory allocation.
      tags:
      - Index Service
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/IndexSettings'
      responses:
        '200':
          description: Index settings updated successfully
        '400':
          description: Invalid index settings
        '401':
          description: Unauthorized access
components:
  schemas:
    IndexSettings:
      type: object
      description: Index service configuration
      properties:
        storageMode:
          type: string
          description: Index storage mode
          enum:
          - plasma
          - memory_optimized
          - forestdb
        indexerThreads:
          type: integer
          description: Number of indexer threads
        memorySnapshotInterval:
          type: integer
          description: Memory snapshot interval in milliseconds
        stableSnapshotInterval:
          type: integer
          description: Stable snapshot interval in milliseconds
        logLevel:
          type: string
          description: Log level for the index service
          enum:
          - silent
          - fatal
          - error
          - warn
          - info
          - verbose
          - timing
          - debug
          - trace
  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