Create a Restore Task for recovering files and folders.

post

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

Privileges: RESTORE_MODIFY

Returns the created Restore Task that recovers files and folders.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request to create a Restore Task for recovering files or folders.

Specifies information about a Restore Task that recovers files and
folders.

cloudCredentials

object | null

Specifies the cloud credentials used to authenticate with cloud(Aws).

continueOnError

boolean | null

Specifies if the Restore Task should continue even if the copy operation
of some files and folders fails. If true, the Cohesity Cluster
ignores intermittent errors and recovers as many files and folders
as possible.
If false, the Restore Task stops recovering when a copy operation fails.

fileRecoveryMethod

string | null

enum

Specifies the type of method to be used to perform file recovery.
'kAutoDeploy' indicates that file restore operation wiil be performed using
an ephemeral agent.
'kUseExistingAgent' indicates that file restore operation wiil be performed
using an persistent agent.
'kUseHypervisorAPIs' indicates that file restore operation wiil be performed
using an hypervisor API's.

Allowed:

filenames

array of strings | null

Array of Files or Folders.

Specifies the files and folders to recover from the snapshot.

filenames

filterIpConfig

object | null

Specifies the list of IP addresses that are allowed or denied during
restore. Allowed IPs and Denied IPs cannot be used together.

isFileBasedVolumeRestore

boolean | null

Specifies whether this is a file based volume restore.

mountDisksOnVm

boolean | null

Sepcifies whether this will attach disks or mount disks on the VM side
OR use Storage Proxy RPCs to stream data

name

string | null

Specifies the name of the Restore Task. This field must be set and
must be a unique name.

newBaseDirectory

string | null

Specifies an optional root folder where to recover the selected
files and folders.
By default, files and folders are restored to their original path.

overwrite

boolean | null

If true, any existing files and folders on the operating system
are overwritten by the recovered files or folders. This is the default.
If false, existing files and folders are not overwritten.

password

string | null

Specifies password of the username to access the target source.

preserveAttributes

boolean | null

If true, the Restore Tasks preserves the original file and
folder attributes. This is the default.

restoredFileInfoList

array of objects | null

Specifies information regarding files and directories.

restoredFileInfoList

sourceObjectInfo

object | null

Specifies information about the source object (such as a VM)
that contains the files and folders to recover.
In addition, it contains information about the Protection Job and Job
Run that captured the snapshot to recover from.
To specify a particular snapshot, you must specify a
jobRunId and a startTimeUsecs.
If jobRunId and startTimeUsecs are not specified,
the last Job Run of the specified Job is used.

targetHostType

string | null

enum

Specifies the target host types to be restored.
'kLinux' indicates the Linux operating system.
'kWindows' indicates the Microsoft Windows operating system.
'kAix' indicates the IBM AIX operating system.
'kSolaris' indicates the Oracle Solaris operating system.
'kSapHana' indicates the Sap Hana database system developed by SAP SE.
'kSapOracle' indicates the Sap Oracle database system developed by SAP SE.
'kCockroachDB' indicates the CockroachDB database system.
'kMySQL' indicates the MySQL database system.
'kSapSybase' indicates the SapSybase database system.
'kSapMaxDB' indicates the SapMaxDB database system.
'kSapSybaseIQ' indicates the SapSybaseIQ database system.
'kDB2' indicates the DB2 database system.
'kSapASE' indicates the SapASE database system.
'kMariaDB' indicates the MariaDB database system.
'kPostgreSQL' indicates the PostgreSQL database system.
'kHPUX' indicates the HPUX database system.
'kVOS' indicates the VOS database system.
'kOther' indicates the other types of operating system.

targetParentSourceId

int64 | null

Specifies the registered source (such as a vCenter Server)
that contains the target protection source (such as a VM)
where the files and folders are recovered to.
This field is not required for a Physical Server.

targetSourceId

int64 | null

Specifies the id of the target protection source (such as a VM)
where the files and folders are recovered to.

useExistingAgent

boolean | null

Specifies whether this will use an existing agent on the target vm
to do restore. Following field is deprecated and shall not be used.
Please refer to the FileRecoveryMethod field for more information.

username

string | null

Specifies username to access the target source.

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

201Success

defaultError