HomeTamr Core GuidesTamr Core API Reference
Tamr Core GuidesTamr Core API ReferenceTamr Core TutorialsEnrichment API ReferenceSupport Help CenterLog In

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

Field

Description

id

Required. The ID of the backup started. Unique across the entire deployment of Tamr.

type

The type of operation.

description

A description of the backup.

status

A JSON object, containing a field for state of the backup, start time, and end time if applicable.

created

A JSON object, containing a field for who created it, time created and version of Tamr being backed-up.

lastModified

A JSON object, containing a field for who modified it, time modified and version of Tamr being backed-up.

result

The result of the backup.

relativeId

The relative ID of the backup. A shortened version of the full ID.

Language