Copies an available backup snapshot of an OCI (Gen 2) environment so that it is available for import into the environment. This command does not work in Classic Oracle Enterprise Performance Management Cloud environments.

Use the listBackups command to determine if the backup you want to restore is available. Self-service restoration of a snapshot to the environment saves you processing time. After restoring the snapshot, use the importSnapshot command to import it into the environment.

Applies to

Planning, Planning Modules, FreeForm, Financial Consolidation and Close, Tax Reporting, Account Reconciliation, Profitability and Cost Management, Enterprise Profitability and Cost Management,Oracle Enterprise Data Management Cloud, Narrative Reporting, Oracle Sales Planning Cloud, and Oracle Strategic Workforce Planning Cloud.

Required Roles

Service Administrator


epmAutomate restoreBackup SNAPSHOT_NAME [targetName=TARGET_SNAPSHOT_NAME], where:

  • SNAPSHOT_NAME is the name of a backup snapshot available in the environment as listed by the listBackups command.
  • targetName, optionally, is the name for the backup snapshot, without an extension, in the target environment. If you do not specify this value, the backup snapshot is restored to the target environment using the SNAPSHOT_NAME , but with a _ (underscore) replacing the / (slash). For example, if SNAPSHOT_NAME is 2022-05-14T00:08:56/ the targetName will be


  • Services other than Narrative Reporting:

    epmAutomate restoreBackup 2022-05-14T00:08:56/ targetName=example_Artifact_Snapshot

  • Narrative Reporting only:

    epmAutomate restoreBackup 2022-02-16T21:00:02/EPRCS_Backup targetName=Example_EPRCS_Backup