Standby Links
Create Standby Link Failover
Creates a new failover operation to promote a standby cluster or reverse cluster roles. The standby link must be in ACTIVE status to initiate a failover.
post/api/atlas/v2/groups/{groupId}/standbyLinks/{standbyLinkId}/failovers
Path parameters
groupIdstring required
Unique 24-hexadecimal digit string that identifies the project.
standbyLinkIdstring required
Unique 24-hexadecimal digit string that identifies the standby link.
Query parameters
envelopeboolean
Flag that indicates whether to wrap the response in an envelope.
Response
Failover operation created successfully.