Back Up a Collection

Back up a collection.

Request

Send an HTTP request with these elements.

Element Description

Method

POST

Endpoint

customers/customerId/backups/

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 identifies the collection to back up:

{
  "collection": "string"
}

Response

A response from a request to back up a collection 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 backup created:

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

Example

Request:

curl https://pg01.us-west1.cloud.lucidworks.com/managed/api/customers/lucidworks/tasks/72 -H "accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer accessTokenManagedSearch"

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

Response:

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