Performs a Recovery.

post

https://cluster.ip.address/v2/data-protect/recoveries

Privileges: RESTORE_MODIFY, REMOTE_RESTORE

Performs a Recovery.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Specifies the parameters to create a Recovery.

Specifies the request parameters to create a Recovery.

filterParams

object

Specifies the params for filtering the entity to be recovered. Depending on the recovery type, this can be used to filter the items within an entity or the entities themselves.

name

string | null

required

Specifies the name of the Recovery.

nfsProtocol

string | null

enum

Specifies NFS protocol version. This protocol will be employed if the recovery request mounts the Cohesity storage via NFS on the primary source.

Allowed:

snapshotEnvironment

string

enum

required

Specifies the type of environment of snapshots for which the Recovery has to be performed.

acropolisParams

object

Specifies the parameters which are specific to Acropolis related Recovery.

awsParams

object

Specifies the parameters which are specific to AWS related Recovery.

azureDevOpsParams

object

Specifies the parameters which are specific to Azure DevOps related Recovery.

azureParams

object

Specifies the parameters which are specific to Azure related Recovery.

cassandraParams

object

Specifies the parameters which are specific to Cassandra Recovery.

confluenceParams

object

Specifies the parameters which are specific to Confluence related Recovery.

couchbaseParams

object

Specifies the parameters which are specific to Couchbase Recovery.

db2Params

object

Specifies the parameters which are specific to DB2 Recovery.

elastifileParams

object

Specifies the parameters which are specific to Elastifile related Recovery.

exchangeParams

object

Specifies the parameters which are specific to Exchange related Recovery.

experimentalAdapterParams

object

Specifies the parameters which are specific to Experimental Adapter Recovery.

flashbladeParams

object

Specifies the parameters which are specific to FlashBlade related Recovery.

gcpParams

object

Specifies the parameters which are specific to GCP related Recovery.

genericNasParams

object

Specifies the parameters which are specific to Generic NAS related Recovery.

gitHubParams

object

Specifies the parameters which are specific to GitHub related Recovery.

googleWorkspaceParams

object

Specifies the parameters which are specific to Google Workspace related Recovery.

gpfsParams

object

Specifies the parameters which are specific to GPFS related Recovery.

hbaseParams

object

Specifies the parameters which are specific to Hbase Recovery.

hdfsParams

object

Specifies the parameters which are specific to HDFS Recovery.

hiveParams

object

Specifies the parameters which are specific to Hive Recovery.

hpeVmeParams

object

Specifies the parameters which are specific to HPE VME (Morpheus) related Recovery.

hypervParams

object

Specifies the parameters which are specific to HyperV related Recovery.

ibmFlashSystemParams

object

Specifies the parameters which are specific to Ibm FlashSystem related Recovery.

isilonParams

object

Specifies the parameters which are specific to Isilon related Recovery.

jiraParams

object

Specifies the parameters which are specific to Jira related Recovery.

kubernetesParams

object

Specifies the parameters which are specific to Kubernetes related Recovery.

kvmParams

object

Specifies the parameters which are specific to KVM related Recovery.

mongodbOpsParams

object

Specifies the parameters which are specific to MongoDB Physical Recovery.

mongodbParams

object

Specifies the parameters which are specific to MongoDB Recovery.

mssqlParams

object

Specifies the parameters which are specific to MsSQL related Recovery.

netappParams

object

Specifies the parameters which are specific to Netapp related Recovery.

nutanixFSParams

object

Specifies the parameters which are specific to Nutanix FS related Recovery.

office365Params

object

Specifies the parameters which are specific to Office 365 related Recovery.

oktaParams

object

Specifies the parameters which are specific to Okta related Recovery.

oracleParams

object

Specifies the parameters which are specific to Oracle related Recovery.

physicalParams

object

Specifies the parameters which are specific to Physical related Recovery.

pineconeParams

object

Specifies the parameters which are specific to Pinecone Recovery.

pingOneParams

object

Specifies the parameters which are specific to PingOne related Recovery.

postgresParams

object

Specifies the parameters which are specific to Postgres Recovery.

pureParams

object

Specifies the parameters which are specific to Pure related Recovery.

qumuloParams

object

Specifies the parameters which are specific to Qumulo related Recovery.

s3CompatibleParams

object

Specifies the parameters which are specific to S3 Compatible Recovery.

salesforceParams

object

Specifies the parameters which are specific to Salesforce related Recovery.

sapHanaParams

object

Specifies the parameters which are specific to SAP HANA Recovery.

serviceNowParams

object

Specifies the parameters which are specific to ServiceNow related Recovery.

sfdcParams

object | null

Specifies the parameters which are specific to Salesforce related Recovery.

udaParams

object

Specifies the parameters which are specific to Universal Data Adapter Recovery.

viewParams

object | null

Specifies the parameters which are specific to View related Recovery.

vmwareParams

object

Specifies the parameters which are specific to VMware related Recovery.

Headers

requestInitiatorType

string

enum

Specifies the type of request from UI, which is used for services like magneto to determine the priority of requests.

Allowed:

Responses

Language

Credentials

Loading…

Response

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

application/json

201Success

defaultError