Create a planned run for backup and replication.

post

https://helios.cohesity.com/v2/data-protect/failover/{id}/planned-run

Specifies the configuration required for executing a special run as a part of failover workflow. This special run is triggered during palnned failover to sync the source cluster to replication cluster with minimum possible delta.

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 create a planned run while failover workflow.

cancelNonFailoverRuns

boolean | null

If set to true, other ongoing runs backing up the same set of entities being failed over will be initiated for cancellation. Non conflicting run operations such as replications to other clusters, archivals will not be cancelled. If set to false, then new run will wait for all the pending operations to finish normally before scheduling a new backup/replication.

objects

array of objects | null

required

Specifies the list of all local entity ids of all the objects being failed from the source cluster.

objects*

pauseNextRuns

boolean | null

If this is set to true then unless failover operation is completed, all the next runs will be pasued.

protectionGroupId

string | null

Specifies the active protection group id on the source cluster from where the objects are being failed over.

replicationClusterId

int64 | null

required

Specifies the replication cluster Id where planned run will replicate objects.

runType

string

enum

Specifies the type of the backup run to be triggered by this request. If this is not set defaults to incremental backup.

Allowed:

viewId

int64 | null

If failover is initiated by view based orchastrator, then this field specifies the local view id of source cluster which is being failed over.

Headers

accessClusterId

int64

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

Responses

201Success

defaultError