Recover a failed import

Important

Currently, a recovery package is only created during an import when the source and target environment have a different version of Content Hub.

If an import fails, you can use a recovery package generated during the import and restore your environment using the Sitecore Content Hub CLI.

To recover a failed import:

  1. Locate the job ID either on the Recent processes page or on the Background processes page.

  2. Optionally, to find the failed job using the CLI, you can execute the following command:

    RequestResponse
    ch-cli jobs list -f Import
  3. To obtain the backup order ID required for recovery, execute:

    RequestResponse
    ch-cli jobs report --id <IMPORT_JOB_ID>
  4. To download the recovery package associated with the failed import, execute:

    RequestResponse
    ch-cli orders fetch --id <BACKUP_ORDER_ID>
  5. To restore the tenant using the recovery package, execute:

    RequestResponse
    ch-cli system import -s "<URL_FROM_FETCH_OR_LOCAL_PATH_TO_PACKAGE>"
  6. To verify that the recovery process has completed successfully, execute:

    RequestResponse
    ch-cli jobs status --id <JOB_ID>

Best practices

Follow these best practices to ensure a safe and successful recovery:

  • Review error messages in the simulation summary report before proceeding.

  • Always use the correct CLI context and ensure you have the necessary permissions.

  • Do not skip steps—restoring from an incorrect package or skipping the recovery import can worsen tenant issues.

  • Monitor the import job until it completes to ensure successful recovery.

Do you have some feedback for us?

If you have suggestions for improving this article,