Initiate a failover request.

post

https://cluster.ip.address/v2/data-protect/failover/{id}

Privileges: RESTORE_MODIFY

Initiate a failover request.

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 parameters to initiate a failover. This failover request should be intiaited from replication cluster.

protectionGroupEnvironment

string | null

enum

If this field is specified then protection groups will be looked up only for this specific environment

replicationCluster

object

Specifies the details about replication cluster involved in the failover operation.

sourceCluster

object

Specifies the details about source cluster involved in the failover operation.

Responses

Language

Credentials

Loading…

Response

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

application/json

201Success