Get Information about a Backup

Request
Response
Example

Get information about a specific backup.

Request

Send an HTTP request with these elements.

Element Description

Element	Description
Method	`GET`
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. See Request header fields.
Message body	JSON object that contains the backup ID: `{ "id": "string" }`

Method

GET

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.

See Request header fields.

Message body

JSON object that contains the backup ID:

{
  "id": "string"
}

Response

A response from a request to get information about a specific 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. See Response header fields.
Message body	JSON object that contains status information about the backup.

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.

See Response header fields.

Message body

JSON object that contains status information about the backup.

Example

Request:

curl "https://pg01.us-west1.cloud.lucidworks.com/managed/api/customers/lucidworks/clusters/$clusterId/backups/$backupId" -H "accept: application/json" -H "Authorization: Bearer $accessTokenManagedSearch"

The method GET is implicit in the curl command.