Backups API

Overview of endpoints and methods

Overview of endpoints and methods

The Backups API has these endpoints and methods:

Method Use

Method	Use
All backups Endpoint: `customers/customerId/backups/`
`GET`	Get a list of all backups for collections in a cluster.
`POST`	Back up of a collection.
`DELETE`	Delete all backups of collections in a cluster.
A specific backup Endpoint: `customers/customerId/backups/backupId`
`GET`	Get information about a specific backup.
`POST`	Restore a collection from a specific backup.
`DELETE`	Delete a specific backup.

All backups
Endpoint: customers/customerId/backups/

GET

Get a list of all backups for collections in a cluster.

POST

Back up of a collection.

DELETE

Delete all backups of collections in a cluster.

A specific backup
Endpoint: customers/customerId/backups/backupId

GET

Get information about a specific backup.

POST

Restore a collection from a specific backup.

DELETE

Delete a specific backup.

To obtain HTTP request URIs, prepend https://pg01.us-west1.cloud.lucidworks.com/managed/api/ to the endpoints shown. For example, the HTTP request URI for the endpoint customers/customerId/backups/ is https://pg01.us-west1.cloud.lucidworks.com/managed/api/customers/customerId/backups/.