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}

Request

  • Base URL
    https://cloud.mongodb.com
  • URL
    https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/standbyLinks/{standbyLinkId}
  • 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.

Response

Standby link retrieved successfully.

Changes

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