Docs Menu

Docs HomeMongoDB Ops Manager

Return the Status of the Connection between Organizations

On this page

  • Required Roles
  • Request
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response
  • Example Request
  • Example Response
  • Response Header
  • Response Body

Return the status of the connection between the specified source Ops Manager organization and the target MongoDB Atlas organization.

Your API Key must have the Organization Owner role to successfully call this resource.

Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /orgs/{orgId}/liveExport/migrationLink/status
Name
Type
Necessity
Description
orgId
string
Required
Unique 24-hexadecimal digit string that identifies the source organization that contains the projects to be migrated to MongoDB Atlas.

The following query parameters are optional:

Name
Type
Necessity
Description
Default
pretty
boolean
Optional
Flag indicating whether the response body should be in a prettyprint format.
false
envelope
boolean
Optional

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

Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

For endpoints that return one result, the response body includes:

Name
Description
status
HTTP response code
envelope
Expected response body
false

This endpoint doesn't use HTTP request body parameters.

Name
Type
Description
status
string

State of the connection that exists between this organization and the target cluster in the MongoDB Atlas organization.

Response returns "SYNCED" or "NOT_SYNCED".

curl --user '{USERNAME}:{APIKEY}' --digest \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--include \
--request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{orgId}/liveExport/migrationLink/status?pretty=true'
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
{
"status": "SYNCED"
}
←  Remove the Connection between OrganizationsOps Manager Administration API Error Codes →