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

Restore Tamr from a Backup

Restore Tamr from a backup.

The restore endpoint begins restoring Tamr and returns an object with metadata describing the restore operation.

The POST body should be a string pointing to the location of your backup. Acceptable backup locations are S3, HDFS, GCS, or a local folder.

If the backup is in S3, before starting a restore operation, specify your access credentials as follows: TAMR_UNIFY_BACKUP_AWS_ACCESS_KEY_ID and TAMR_UNIFY_BACKUP_AWS_SECRET_ACCESS_KEY.


Once Tamr starts the restore process, the service returns its ID. Use the ID to look up the status of the restore operation. See Check Restore Status.

Response Fields




The unique ID of the restore process that has started.


The shortened ID of the restore process. Use this ID for querying for its status.


A description of the restore process.


A JSON object, containing a field for start time.


A JSON object, containing a field for the time when the restore operation was created, and who created it.


The relative ID of the restore operation that has started.

About the Restore Process

The restore process puts Tamr in a quiet state where only the restore process runs, most service endpoints are unavailable, and you cannot use the user interface.

The restore process reads backup data from the location provided to the start restore service method. You can specify physical disk backup locations and locations in AWS S3, GCS, and HDFS.

The restore process updates Tamr with a subset of the service-related configuration stored through the Tamr administration utility. See Additional Configuration Variables for Backup.


Restoring the Tamr Configuration

Any configurations that you have not stored with the backup or included in the list of automatically-backed up variables are overwritten during the restore operation. You can add all additional configuration properties to the TAMR_UNIFY_BACKUP_EXTRA_CONFIG_PROPS list before you start the backup.

Tamr becomes available once the restore process completes. During the restore process, Tamr issues an error message: The system is temporarily in a read-only mode.

When the restore process is complete, you must restart Tamr and its dependencies to apply the new configuration. See Restarting.