Qodex.ai

Recover File

POST https://{{cluster-vip}}/v2/data-protect/recoveries

Recover the objects from the snapshot ID specified in the request body.

Ensure to provide the following parameters in the request body:

  • The snapshot ID from which you want to recover the specified object.
  • The target ID where the object will be recovered to.

The {{timestamp}} variable in the request body will be auto-populated when you run the API.

Request Body

{"name"=>"Recover_{{timestamp}}", "snapshotEnvironment"=>"kGenericNas", "genericNasParams"=>{"objects"=>[{"snapshotId"=>"{{snapshotId}}"}], "recoveryAction"=>"RecoverFiles", "recoverFileAndFolderParams"=>{"filesAndFolders"=>[{"absolutePath"=>"/1.txt", "isDirectory"=>false}], "targetEnvironment"=>"kGenericNas", "genericNasTargetParams"=>{"recoverToNewSource"=>false, "originalSourceConfig"=>{"overwriteExistingFile"=>false, "preserveFileAttributes"=>true, "continueOnError"=>true, "encryptionEnabled"=>false, "recoverToOriginalPath"=>true}}}}}

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring
Content-Typestring

RESPONSES

status: Created

{"id":"8743635867054034:1666901032964:412830","name":"Recover_20230131_131039","startTimeUsecs":1675199439525195,"status":"Running","progressTaskId":"restore_files_412830","snapshotEnvironment":"kGenericNas","recoveryAction":"RecoverFiles","permissions":[],"creationInfo":{"userName":"admin"},"canTearDown":false,"messages":null,"genericNasParams":{"objects":[{"snapshotId":"{{snapshotId}}","protectionGroupId":"8743635867054034:1666901032964:412249","protectionGroupName":"{{protectionGroupName2}}","snapshotCreationTimeUsecs":1675193584348281,"snapshotTargetType":"Local","storageDomainId":24,"progressTaskId":"","messages":null,"objectInfo":{"id":25267,"name":"{{objectname}}","sourceName":"NAS Mount Points","environment":"kGenericNas","objectType":"kHost"}}],"recoveryAction":"RecoverFiles","recoverFileAndFolderParams":{"filesAndFolders":[{"absolutePath":"/1.txt","isDirectory":false,"status":"NotStarted","messages":null}],"targetEnvironment":"kGenericNas","genericNasTargetParams":{"recoverToNewSource":false,"originalSourceConfig":{"recoverToOriginalPath":true,"overwriteExistingFile":false,"preserveFileAttributes":true,"continueOnError":true,"encryptionEnabled":false}}}}}