/public/restore/recover

put

https://cluster.ip.address/irisservices/api/v1/public/restore/recover

Privileges: RESTORE_MODIFY

Updates an existing restore task with additional params which are needed for
features like Hot-Standby.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

UpdateRestoreTaskParams holds the information to update a Restore Task in
Magneto.

adOptions

object | null

Specifies the Active Directory options to update the Restore Task with.

childRestoreTaskIds

array of int64s | null

Specifies the ID of the child restore tasks of 'RestoreTaskId' to which
the update is meant.

childRestoreTaskIds

enableAutoSync

boolean | null

Enables Auto Sync feature for SQL Multi-stage Restore task.

options

object | null

Specifies generic options to update the restore task.

oracleOptions

object | null

Specifies the oracle options to update the Restore Task with.

restoreTaskId

int64 | null

Specifies the ID of the existing Restore Task to update.

sqlOptions

string | null

enum

Specifies the sql options to update the Restore Task with.
Specifies the action type of multi stage SQL restore.

'kCreate' specifies the create action for a restore.
'kUpdate' specifies the user action to update an ongoing restore.
'kFinalize' specifies the user action to finalize a restore.

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Specifies the response of the UpdateRestoreTask API. Success

defaultError