MongoDBMongoDB Atlas Administration API v2
GET/api/atlas/v2/groups/{groupId}/standbyLinks/{standbyLinkId}/failovers/{failoverId}
Read get Group Standby Link Failover.
Contract-preserving GET endpoint for get Group Standby Link Failover in the MongoDB Atlas Administration API. Resource-specific values are supplied by the caller at runtime.
All 540 MongoDB Atlas administration endpoints from a fixed Apache-2.0 OpenAPI revision. Hub provides documentation and an independent SDK/CLI, but never proxies account, organization, project, network, backup, or operational data; callers connect directly with local credentials.
Request
- operationId
getGroupStandbyLinkFailover- Server
https://cloud.mongodb.com- Authentication
- ServiceAccounts, DigestAuth
Request parameters
groupId
pathstringrequired
group Id value in the Atlas Administration API contract.
standbyLinkId
pathstringrequired
standby Link Id value in the Atlas Administration API contract.
failoverId
pathstringrequired
failover Id value in the Atlas Administration API contract.
envelope
queryboolean
envelope value in the Atlas Administration API contract.
Responses
200
ApiStandbyLinkFailoverResponseapplication/vnd.atlas.preview+json
Successful supplier response.
Properties: completedAtcreatedDatefailoverIdfailoverStagestandbyLinkIdstatustype
400
ApiErrorapplication/json
Supplier response with HTTP status 400.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
401
ApiErrorapplication/json
Supplier response with HTTP status 401.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
403
ApiErrorapplication/json
Supplier response with HTTP status 403.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
404
ApiErrorapplication/json
Supplier response with HTTP status 404.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
500
ApiErrorapplication/json
Supplier response with HTTP status 500.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
{
"failoverId": "32b6e34b3d91647abb20e7b8",
"failoverStage": "PREPARING_TO_STOP_REPLICATION",
"standbyLinkId": "32b6e34b3d91647abb20e7b8",
"status": "INITIALIZING",
"type": "UNPLANNED"
}