Couchbase Data API

openapi: 3.1.0
info:
  title: Couchbase Analytics Service REST Allowed CIDRs Data 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: Data
  description: Endpoints for triggering backup and restore data operations.
paths:
  /api/v1/cluster/self/repository/active/{repositoryId}/backup:
    post:
      operationId: triggerImmediateBackup
      summary: Trigger an immediate backup
      description: Triggers an immediate one-off backup for the specified active repository, independent of the scheduled backup plan.
      tags:
      - Data
      parameters:
      - $ref: '#/components/parameters/repositoryId'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                full_backup:
                  type: boolean
                  description: Whether to perform a full backup instead of incremental
      responses:
        '200':
          description: Backup triggered successfully
        '401':
          description: Unauthorized access
        '404':
          description: Repository not found
  /api/v1/cluster/self/repository/active/{repositoryId}/restore:
    post:
      operationId: restoreFromBackup
      summary: Restore from a backup
      description: Initiates a restore operation from the specified backup repository, allowing you to restore specific buckets or all data.
      tags:
      - Data
      parameters:
      - $ref: '#/components/parameters/repositoryId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestoreRequest'
      responses:
        '200':
          description: Restore operation initiated
        '400':
          description: Invalid restore configuration
        '401':
          description: Unauthorized access
        '404':
          description: Repository not found
components:
  parameters:
    repositoryId:
      name: repositoryId
      in: path
      required: true
      description: The name of the backup repository
      schema:
        type: string
  schemas:
    RestoreRequest:
      type: object
      description: Restore operation request
      properties:
        target:
          type: string
          description: Target cluster for the restore
        start:
          type: string
          format: date-time
          description: Start date for the restore range
        end:
          type: string
          format: date-time
          description: End date for the restore range
        include_buckets:
          type: array
          description: Buckets to include in the restore
          items:
            type: string
        exclude_buckets:
          type: array
          description: Buckets to exclude from the restore
          items:
            type: string
        map_data:
          type: string
          description: Bucket mapping for restoring to a different bucket name
        auto_create_buckets:
          type: boolean
          description: Whether to auto-create buckets that do not exist
        auto_remove_collections:
          type: boolean
          description: Whether to remove collections not in the backup
  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