MongoDBMongoDB Atlas Administration API v2
GET/api/atlas/v2/groups/{groupId}/standbyLinks/{standbyLinkId}:inspectFailoverReadiness
Read inspect Group Standby Link Failover Readiness.
Contract-preserving GET endpoint for inspect Group Standby Link Failover Readiness 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
inspectGroupStandbyLinkFailoverReadiness- 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.
envelope
queryboolean
envelope value in the Atlas Administration API contract.
pretty
queryboolean
pretty value in the Atlas Administration API contract.
Responses
200
ApiStandbyLinkFailoverReadinessResponseapplication/vnd.atlas.preview+json
Successful supplier response.
Properties: estimatedDataLossSecondsestimatedFailoverTimeSecondsgroupIdstandbyLinkId
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
429
ApiErrorapplication/json
Supplier response with HTTP status 429.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
500
ApiErrorapplication/json
Supplier response with HTTP status 500.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
503
ApiErrorapplication/json
Supplier response with HTTP status 503.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
{
"estimatedDataLossSeconds": 3,
"estimatedFailoverTimeSeconds": 45,
"groupId": "69af15ed46c6ab2dbf1c3d0e",
"standbyLinkId": "6655f1f77bcf86cd79943901"
}