MOmongodb
Standby Links

Return One Standby Link Failover

Returns the current status and details of a specific failover operation for a standby link.

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

Request

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

failoverIdstring required

Unique 24-hexadecimal digit string that identifies the failover operation.

Query parameters

envelopeboolean

Flag that indicates whether to wrap the response in an envelope.

Response

Failover operation retrieved successfully.

Changes

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