User GuidesAPI ReferenceRelease Notes
Doc HomeHelp CenterLog In
API Reference

Check Backup Status

Obtain the status of the Tamr backup process.

Use this endpoint to poll for the status of the backup process with the specified backup ID. It returns a JSON object describing the backup. The status section can have the following possible states: SUCCEEDED, PENDING, RUNNING, or FAILED.

To obtain the status of all backups, omit the optional backup ID.

Response Fields

FieldDescription
idRequired. The ID of the backup started. Unique across the entire deployment of Tamr.
typeThe type of operation.
descriptionA description of the backup.
statusA JSON object, containing a field for state of the backup, start time, and end time if applicable.
createdA JSON object, containing a field for who created it, time created and version of Tamr being backed-up.
lastModifiedA JSON object, containing a field for who modified it, time modified and version of Tamr being backed-up.
resultThe result of the backup.
relativeIdThe relative ID of the backup. A shortened version of the full ID.
Language