MOmongodb
Standby Links

Create Standby Link

Creates a disaster recovery standby link between an active cluster and a standby cluster. Both clusters must not already be part of a standby link system, must be single-region clusters, and must be in different regions.

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

Request

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

Query parameters

envelopeboolean

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

Request body

activeClusterUniqueIdstring required

Unique 24-hexadecimal digit string that identifies the active cluster in the standby link.

standbyClusterUniqueIdstring required

Unique 24-hexadecimal digit string that identifies the standby cluster in the standby link.

Example request

{
  "activeClusterUniqueId": "507f191e810c19729de860ea",
  "standbyClusterUniqueId": "507f191e810c19729de860eb"
}

Response

Standby link created successfully.

Changes

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