Couchbase

Couchbase Replications API

Endpoints for creating, managing, and deleting XDCR replication streams.

Documentation GitHub OpenAPI

Operations 2

POST /controller/createReplication Create an XDCR replication #

DELETE /controller/cancelXDCR/{replicationId} Delete an XDCR replication #

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-replications-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 XDCR REST Replications API
  description: The Couchbase XDCR (Cross Data Center Replication) REST API enables configuration and management of data replication between Couchbase clusters across different data centers. It provides endpoints for creating replication references, configuring replication streams, monitoring replication statistics, and managing replication settings. XDCR supports both unidirectional and bidirectional replication for high availability and disaster recovery scenarios.
  version: '7.6'
  contact:
    name: Couchbase Support
    url: https://support.couchbase.com
  termsOfService: https://www.couchbase.com/terms-of-use
servers:
- url: https://localhost:8091
  description: Couchbase Server (default port)
- url: https://localhost:18091
  description: Couchbase Server (SSL)
security:
- basicAuth: []
tags:
- name: Replications
  description: Endpoints for creating, managing, and deleting XDCR replication streams.
paths:
  /controller/createReplication:
    post:
      operationId: createReplication
      summary: Create an XDCR replication
      description: Creates a new XDCR replication stream from a source bucket to a target bucket on a remote cluster.
      tags:
      - Replications
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ReplicationCreateRequest'
      responses:
        '200':
          description: Replication created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Replication ID
        '400':
          description: Invalid replication configuration
        '401':
          description: Unauthorized access
  /controller/cancelXDCR/{replicationId}:
    delete:
      operationId: deleteReplication
      summary: Delete an XDCR replication
      description: Deletes the specified XDCR replication stream, stopping all data replication for that stream.
      tags:
      - Replications
      parameters:
      - $ref: '#/components/parameters/replicationId'
      responses:
        '200':
          description: Replication deleted successfully
        '401':
          description: Unauthorized access
        '404':
          description: Replication not found
components:
  parameters:
    replicationId:
      name: replicationId
      in: path
      required: true
      description: The XDCR replication ID in the format {remoteClusterUUID}/{sourceBucket}/{targetBucket}
      schema:
        type: string
  schemas:
    ReplicationCreateRequest:
      type: object
      description: Request to create an XDCR replication
      required:
      - fromBucket
      - toCluster
      - toBucket
      - replicationType
      properties:
        fromBucket:
          type: string
          description: Name of the source bucket
        toCluster:
          type: string
          description: Name of the remote cluster reference
        toBucket:
          type: string
          description: Name of the target bucket on the remote cluster
        replicationType:
          type: string
          description: Type of replication
          enum:
          - continuous
        filterExpression:
          type: string
          description: Regular expression filter for document IDs
        compressionType:
          type: string
          description: Compression type for replication data
          enum:
          - None
          - Auto
          - Snappy
        priority:
          type: string
          description: Replication priority
          enum:
          - High
          - Medium
          - Low
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using Couchbase Server administrator credentials.
externalDocs:
  description: Couchbase XDCR REST API Documentation
  url: https://docs.couchbase.com/server/current/rest-api/rest-xdcr-intro.html