Activate failover entity backup on replication clsuter.

post

https://helios.cohesity.com/v2/data-protect/failover/{id}/backup-activation

Specifies the configuration required for activating backup for failover objects on replication cluster. Here orchastrator can call this API multiple times as long as full set of object are non-overlapping. They can also use the existing job if its compatible to backup failover objects.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Specifies the id of the failover workflow.

Body Params

Specifies the paramteres to activate the backup of failover entities.

createObjectBackup

boolean | null

If set to true then object based backups will be created for the failed over VMs.

doNotProtect

boolean | null

Whether to skip protecting the failed over entities previously specified via Initiate Failover API.

enableReverseReplication

boolean | null

If this is specifed as true, then reverse replication of failover objects will be enabled from replication cluster to source cluster. If source cluster is not reachable, then replications will fail until source cluster comes up again. Here orchastrator should also ensure that storage domain on replication cluster is correctly mapped to the same storage domain on the source cluster.

objects

array of objects | null

Specifies the list of failover object that need to be protected on replication cluster. If the object set that was sent earlier is provided again then API will return an error. If this objects list is not specified then internally it will be inferred if '/objectLinkage' API has been called previously.

objects

protectionGroupId

string | null

Specifies the protection group id that will be used for backing up the failover entities on replication cluster. This is a optional argument and only need to be passed if user wants to use the existing job for the backup. If specified then Orchastrator should enusre that protection group is compatible to handle all provided failover objects.

targetFailoverEnvironment

string | null

enum

If this is specified, then the protection environment of the failed over objects will be set to this. Otherwise, the protection environment of the failed over objects is determined by the objects' environment.

targetFailoverPolicyId

string | null

Policy which will be used in the protection of the failed over objects.

Headers

accessClusterId

int64

This field uniquely represents a Cohesity Cluster and is used for making on-prem calls from Helios.

Responses

201Success

defaultError