Create a remote Vault restore task. (CloudRetrieve)

post

https://cluster.ip.address/irisservices/api/v1/public/remoteVaults/restoreTasks

Privileges: REMOTE_RESTORE

Returns the id of the remote Vault restore Task that was created.

After a Vault is searched by a search Job, this operation can be
called to create a task that restores the indexes and/or the Snapshots
of a Protection Job, which were archived on a remote Vault (External Target).
This is part of the CloudRetrieve functionality for finding and restoring
archived data from remote Vaults to an alternative (non-original) Cluster.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request to create a remote Vault restore task.

Specifies settings required to create a task that restores the
index and/or the Snapshots of a Protection Job from a remote Vault
to the current Cluster.

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:

restoreObjects

array of objects | null

Array of Restore Objects.

Specifies the list of Snapshots and the index to be restored from the
remote Vault. The data on the remote Vault may have been
originally archived from multiple remote Clusters.

restoreObjects

searchJobUid

object | null

required

Specifies the unique id of the remote Vault search Job.

taskName

string | null

required

Specifies a name of the restore task.

vaultId

int64 | null

required

Specifies the id of the Vault that contains the index and
Snapshots to restore to the current Cluster.
This is the id assigned by the Cohesity Cluster when Vault was
registered as an External Target.

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