MOmongodb
Standby Links

Return All Standby Link Failovers

Returns all failover operations for the specified standby link. Each failover represents a planned or unplanned process to promote a standby cluster to an active cluster.

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

Request

  • Base URL
    https://cloud.mongodb.com
  • URL
    https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/standbyLinks/{standbyLinkId}/failovers
  • 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 Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

itemsPerPageinteger

Number of items that the response returns per page.

pageNuminteger

Number of the page that displays the current set of the total objects that the response returns.

prettyboolean

Flag that indicates whether the response body should be in the prettyprint format.

Response

OK

Changes

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