MOmongodb
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

Request

  • Base URL
    https://cloud.mongodb.com
  • URL
    https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/standbyLinks/{standbyLinkId}/failovers
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://cloud.mongodb.com/api/oauth/token
    • or HTTP digest

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.

Request body

type'UNPLANNED' | 'PLANNED_REVERSE' | 'PLANNED' required

Type of failover operation to perform.

Response

Failover operation created successfully.

Changes

No recorded changes to this operation across all 1 revision of this API.