This endpoint starts the asynchronous process of restoring resources into the specified applications' recovery (target) endpoints from recovery point information created by previous backup processes. It can be called with an apps object for new restore executions or with retryJobId for re-executing a previous restore job. For new restore executions, the request object must contain an apps object whose keys are the application IDs to restore, and whose values are application restore request objects, each containing some of the following properties:

recoveryPointId
syncPhase
enableRealTimeSync
enableNetworkSandbox
networkSandboxWhitelist

Specify recoveryPointId to restore resources from a specific recovery point. If not specified, the application is restored at the recovery point it was most recently restored to. Specify syncPhase to control which phase the application is restored to. Valid values are: standby, failover, failoverTest. When syncPhase is failoverTest, enableNetworkSandbox controls whether network sandboxing is enabled (flag is true) or disabled (flag is false) for the application. For other syncPhase values, the flag is ignored. When syncPhase is failoverTest, and enableNetworkSandboxistrue, the networkSandboxWhitelistflag can be used to excempt some IP CIDR ranges from the sandbox. IfrecoveryPointIdis provided, the request may also include a booleanenableRealTimeSyncflag, indicating whether real-time replicated resources should be restored with their latest data (flag istrue), or instead to a snapshot captured when the specified recovery point was created (flag is false). If recoveryPointId is specified, but this field is omitted, it defaults to false. If neither field is specified, the value from the prior restore request is used. If protect_recovery_point is set to True, the recovery point used in this restore will be set to protected and will not be eligible for clean up. When an application's syncPhase is changing from failover or failoverTest to standby, the request may also include testResult to record the outcome you observed for the recovery test this restore concludes. Valid values are success and failed. It is rejected for any other syncPhase transition. Recorded results are kept permanently and are never overwritten. Testing an application again and concluding it records a new result; the previous ones stay readable, and the most recent one is the one reported for the application. For retrying a previously executed job, the retryJobId must be set to the ID of a completed restoreApp job. The restoration of the resources that failed to in this job will be retried. The optional restoreType property declares the caller's intent: retry (a full re-run; only valid with apps) or resume (failed resources only; valid with retryJobId).