Standby Links
Inspect Failover Readiness for One Standby Link
Returns the failover readiness metrics for the specified standby link in the specified project. The response includes the readiness snapshot identifiers, estimated data loss and failover time values. Use this endpoint to assess potential data loss before triggering an unplanned failover.
get/api/atlas/v2/groups/{groupId}/standbyLinks/{standbyLinkId}:inspectFailoverReadiness
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.
prettyboolean
Flag that indicates whether the response body should be in the prettyprint format.
Response
OK