Restore a Collection from a Specific Backup

Restore a collection from a specific backup.

Request

Send an HTTP request with these elements.

Element Description

Method

POST

Endpoint

customers/customerId/backups/backupId

Request header fields

Request header fields specify metadata for the request. For example, the Authorization header contains the OAuth2 access token.

Message body

JSON body that contains the collectionId of the collection to which to restore the backup:

{
  "toCollection": "string"
}

Response

A response from a request to restore a backup contains these elements.

Element Description

Status line

The status line contains the status code and the reason phrase.

Response header fields

Response header fields specify metadata about the response.

Message body

JSON object that contains status information about the request and a taskId:

{
  "status": "string",
  "taskId": "string"
}

Example

Request:

curl -vs "https://pg01.us-west1.cloud.lucidworks.com/managed/api/customers/lucidworks/clusters/$clusterId/backups/$backupId/restores" -H "accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer $accessTokenManagedSearch" -d @$NEWDATE/body-restore-collection.json

The method POST is implicit in the curl command.

Response:

{
  "status": "string",
  "taskId": "string"
}