sync

Get Flexible Sync information

Changed on

Retrieve sync data for a specific Atlas App Services App when using Flexible Sync.

get/groups/{groupId}/apps/{appId}/service/{serviceId}/config

Request

  • Base URL
    https://services.cloud.mongodb.com/api/admin/v3.0
  • URL
    https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/service/{serviceId}/config
  • Auth
    HTTP bearer

Response

Successfully retrieved.

clusterIdstring

The Service ID for the linked cluster.

clusterNamestring

The name of the linked cluster

clusterType'atlas' | 'serverless'

The service type of the linked cluster ("atlas" by default)

groupNamestring

The name of the App's Atlas Project.

orgNamestring

The name of the App's Atlas Organization.

readPreference'primary' | 'primaryPreferred' | 'secondary' | 'secondaryPreferred' | 'nearest'
wireProtocolEnabledboolean

If true, clients may connect to the app over the MongoDB Wire Protocol.

Changes

  • v38193942eef1dRevision changes
    • warning

      removed the optional property / from the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      the response property / became required for the status

  • v3e2240dd053bdRevision changes
    • warning

      added the new atlas enum value to the response property for the response status

    • warning

      added the new serverless enum value to the response property for the response status