Backup Service API
- reference
The Backup Service API allows full and incremental data-backups to be planned and scheduled; allows the scheduling of merges of previously made backups; and allows existing backups to be archived.
APIs in this Section
The Backup Service API endpoints can be grouped into several categories:
For an overview of the Backup Service, see Backup Service. For information on using Couchbase Server Web Console to configure and use the Backup Service, see Manage Backup and Restore.
All calls require the Full Admin role, and use port 8097.
Each URI, in Couchbase Server Enterprise Edition Version 7.0, must be prefixed with /api/v1.
Note that for all cluster references, in Couchbase Server Enterprise Edition Version 7.0 and 7.1, only the host cluster is supported, and is referred to as self.
For a list of the methods and URIs covered in these pages, see the tables below.
Configuration
| HTTP Method | URI | Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Repository
| HTTP Method | URI | Documented at |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Plan
| HTTP Method | URI | Documented at |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Task
| HTTP Method | URI | Documented at |
|---|---|---|
|
|
|
|
|