User GuidesAPI ReferenceRelease Notes
Doc HomeHelp CenterLog In
API Reference

Check Backup Status

Get backup information

This endpoint can be used to poll the status of backup, given the backup ID. It will return a JSON object describing the backup, and the status section will either say SUCCEEDED, PENDING, RUNNING, or FAILED.

Omit the optional backup ID to get all backups.

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