Create a Restore Task for recovering VMs or instantly mounting volumes.

post

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

Privileges: RESTORE_MODIFY

Returns the created Restore Task. This operation returns the following
types of Restore Tasks: 1) A Restore Task that recovers VMs back to the
original location or a new location. 2) A Restore Task that mounts the
volumes of a Server (such as a VM or Physical Server) onto the specified
target system. The Snapshots of the Server that contains the volumes
that are mounted is determined by Array of Objects.
The content of the Server is available from the mount point
for the Granular Level Recovery (GLR) of application data. For example
recovering Microsoft Exchange data using Kroll Ontrack® PowerControls™.

NOTE: Volumes are mounted "instantly" if the Snapshot is stored locally on the
Cohesity Cluster. If the Snapshot is archival target, it will take longer
because it must be retrieved.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request to create a Restore Task for recovering VMs or mounting
volumes to mount points.

Create a Restore Task Request for recovering VMs or mounting volumes to
mount points.

PublicFoldersParameters

object | null

Specifies additional parameters for 'kRecoverO365PublicFolders' restore
objects.

acropolisParameters

object | null

Specifies additional parameters for 'kAcropolis' restore objects.

continueOnError

boolean | null

Specifies if the Restore Task should continue when some operations on some
objects fail. If true, the Cohesity Cluster ignores intermittent
errors and restores as many objects as possible.

deployVmsToCloud

object | null

Specifies parameters to deploy VMs to cloud.

glacierRetrievalType

string | null

enum

Specifies the way data needs to be retrieved from the external target.
This information will be filled in by Iris and Magneto will pass it along
to the Icebox as it is to support bulk retrieval from Glacier.
Specifies the type of Restore Task.

'kStandard' specifies retrievals that allow to access any of your archives
within several hours. Standard retrievals typically complete within 3–5
hours. This is the default option for retrieval requests that do not specify
the retrieval option.
'kBulk' specifies retrievals that are Glacier’s lowest-cost retrieval
option, which can be used to retrieve large amounts, even petabytes, of data
inexpensively in a day. Bulk retrieval typically complete within 5–12 hours.
'kExpedited' specifies retrievals that allows to quickly access your data
when occasional urgent requests for a subset of archives are required. For
all but the largest archives (250 MB+), data accessed using Expedited
retrievals are typically made available within 1–5 minutes.

Allowed:

hypervParameters

object | null

Specifies additional parameters for 'kHyperV' restore objects.

kubernetesParameters

object | null

Specifies additional parameters for 'kKubernetes' restore objects.

mountParameters

object | null

Specifies parameters required for mounting volumes.

name

string | null

required

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

newParentId

int64 | null

Specify a new registered parent Protection Source. If specified
the selected objects are cloned or recovered to this new Protection
Source. If not specified, objects are cloned or recovered
to the original Protection Source that was managing them.

objects

array of objects | null

Array of Objects.

Specifies a list of Protection Source objects or Protection Job objects
(with specified Protection Source objects).

objects

oneDriveParameters

object | null

Specifies additional parameters for 'kRecoverO365Drive' restore objects.

outlookParameters

object | null

Specifies additional parameters for 'kRecoverEmails' restore objects.

restoreViewParameters

object | null

Specifies settings for restoring view.

sharePointParameters

object | null

Specifies additional parameters for 'kRecoverSites' restore objects.

type

string | null

enum

required

Specifies the type of Restore Task such as 'kRecoverVMs' or
'kMountVolumes'.
'kRecoverVMs' specifies a Restore Task that recovers VMs.
'kMountVolumes' specifies a Restore Task that mounts volumes to mount
points.
'kRecoverNamespaces' specifies a Restore Task that recovers Kubernetes
namespaces.
'kMountFileVolume' specifies a Restore Task that mounts a file volume.

Allowed:

viewName

string | null

Specifie target view into which the objects are to be cloned when doing
recovery for NAS.

virtualDiskRestoreParameters

object | null

Specifies parameters for restoring virtual disks from VM.

vlanParameters

object | null

Specifies VLAN parameters for the restore operation.

vmwareParameters

object | null

Specifies additional parameters for 'kVmware' restore objects.

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