MongoDBMongoDB Atlas Administration API v2
POST/api/atlas/v2/groups/{groupId}/standbyLinks
Manage create Group Standby Link.
Contract-preserving POST endpoint for create Group Standby Link 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
createGroupStandbyLink- 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.
Request body
ApiStandbyLinkRequestrequired
Content-Type: application/vnd.atlas.preview+json
Properties: activeClusterUniqueIdstandbyClusterUniqueId
Responses
201
ApiStandbyLinkResponseapplication/vnd.atlas.preview+json
Successful supplier response.
Properties: activeClusterUniqueIderrorReasongroupIdstandbyClusterUniqueIdstandbyLinkIdstatus
400
ApiErrorapplication/json
Supplier response with HTTP status 400.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
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
{
"activeClusterUniqueId": "507f191e810c19729de860ea",
"errorReason": "STANDBY_NOT_EMPTY",
"groupId": "32b6e34b3d91647abb20e7b8",
"standbyClusterUniqueId": "507f191e810c19729de860eb",
"standbyLinkId": "507f1f77bcf86cd799439011",
"status": "INITIALIZING"
}