Couchbase

Couchbase Data API

Endpoints for triggering backup and restore data operations.

Documentation GitHub OpenAPI

Operations 2

POST /api/v1/cluster/self/repository/active/{repositoryId}/backup Trigger an immediate backup #

POST /api/v1/cluster/self/repository/active/{repositoryId}/restore Restore from a backup #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/couchbase-data-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Couchbase Backup Service REST Data API
  description: The Couchbase Backup Service REST API supports management of the Backup Service for Couchbase Server, providing endpoints for cluster configuration, repository management, backup plans, task scheduling, and data operations. It enables automated backup and restore workflows for Couchbase data, allowing administrators to define backup policies, monitor backup tasks, and manage backup repositories programmatically.
  version: '7.6'
  contact:
    name: Couchbase Support
    url: https://support.couchbase.com
  termsOfService: https://www.couchbase.com/terms-of-use
servers:
- url: https://localhost:8097
  description: Backup Service (default port)
- url: https://localhost:18097
  description: Backup 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:
  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
  parameters:
    repositoryId:
      name: repositoryId
      in: path
      required: true
      description: The name of the backup repository
      schema:
        type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication. Requires the Full Admin role.
externalDocs:
  description: Couchbase Backup Service REST API Documentation
  url: https://docs.couchbase.com/server/current/rest-api/backup-rest-api.html