MongoDB/listGroupStandbyLinks

Online calls unavailable · details below

MongoDBMongoDB Atlas Administration API v2

GET/api/atlas/v2/groups/{groupId}/standbyLinks

Read list Group Standby Links.

Contract-preserving GET endpoint for list Group Standby Links in the MongoDB Atlas Administration API. Resource-specific values are supplied by the caller at runtime.

All 540 MongoDB Atlas administration endpoints from a fixed Apache-2.0 OpenAPI revision. Hub provides documentation and an independent SDK/CLI, but never proxies account, organization, project, network, backup, or operational data; callers connect directly with local credentials.

Request

operationId: listGroupStandbyLinks
Server: https://cloud.mongodb.com
Authentication: ServiceAccounts, DigestAuth

Request parameters

`groupId`

pathstringrequired

group Id value in the Atlas Administration API contract.

`envelope`

queryboolean

envelope value in the Atlas Administration API contract.

`itemsPerPage`

queryinteger

items Per Page value in the Atlas Administration API contract.

`pageNum`

queryinteger

page Num value in the Atlas Administration API contract.

`pretty`

queryboolean

pretty value in the Atlas Administration API contract.

Responses

`200`

PaginatedApiStandbyLinkResponseapplication/vnd.atlas.preview+json

Successful supplier response.

Properties: linksresultstotalCount

`401`

ApiErrorapplication/json

Supplier response with HTTP status 401.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

`403`

ApiErrorapplication/json

Supplier response with HTTP status 403.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

`404`

ApiErrorapplication/json

Supplier response with HTTP status 404.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

`500`

ApiErrorapplication/json

Supplier response with HTTP status 500.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

{
  "links": {
    "href": "https://cloud.mongodb.com/api/atlas",
    "rel": "self"
  },
  "results": {
    "activeClusterUniqueId": "507f191e810c19729de860ea",
    "errorReason": "STANDBY_NOT_EMPTY",
    "groupId": "32b6e34b3d91647abb20e7b8",
    "standbyClusterUniqueId": "507f191e810c19729de860eb",
    "standbyLinkId": "507f1f77bcf86cd799439011",
    "status": "INITIALIZING"
  },
  "totalCount": 0
}