v1

latestOpenAPI 3.0.1CC BY-NC-SA 3.0 US2026-07-145251,1312.6 MB
Standby Links

Return One Standby Link

Returns detailed information about a specific standby link including status, group ID, and cluster unique IDs.

get/api/atlas/v2/groups/{groupId}/standbyLinks/{standbyLinkId}

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

Standby link retrieved successfully.