Perform an action on a DR plan.

post

https://helios.cohesity.com/v2/mcm/site-continuity/v2/dr-plans/{id}/actions

Privileges: DRAAS_MODIFY

Performs actions such as activate, failover, failback, etc on a given DR plan.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

Specifies the ID of the DR plan.

Body Params

Specifies the parameters to perform an action on the DR plan.

action

string | null

enum

required

Specifies the current action that is being performed on a DR plan.
'Activate' activates the DR plan which periodically checks the protection and replication status to determine if the DR plan Recovery Point Objective (RPO) is met.
'TestFailover' tests if a failover from the primary site to the DR site works.
'Failover' fails over the resources from primary site to DR site.
'PrepareForFailback' prepares the DR plan for a Failback operation by validating the required configuration for failback to the primary site.
'TestFailback' tests if a failback from the DR site to the primary site works.
'Failback' fails back the resources from DR site to primary site.
'PrepareForFailover' prepares the DR plan for subsequent Failover operation (after a successful Failover and Failback) by validating the required configuration for Failover to the DR site.
'Teardown' can be used to tear down configuration after a failed/partially successful Failover or Failback operation. This option can also be used to tear down configuration after a successful/failed/partially successful Test Failover or Test Failback operation.

failoverParams

object

Specifies the action parameters to trigger failover or failback on a DR plan.

testFailoverParams

object

Specifies the action parameters to trigger failover or failback on a DR plan.

failbackParams

object

Specifies the action parameters to trigger failover or failback on a DR plan.

testFailbackParams

object

Specifies the action parameters to trigger failover or failback on a DR plan.

teardownParams

object

Specifies the action parameters to teardown a DR plan action.

Responses

202Specifies the response after performing an action on the DR plan.

defaultSpecifies the common error definition.