Get Partition-Based Sync information

GET /groups/{groupId}/apps/{appId}/sync/data

Token auth

Retrieve partition field data when using Partition-Based Sync.

Path parameters

groupId string Required

An Atlas Project/Group ID.
appId string Required

The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

Query parameters

service_id string Required

The Service ID for the linked cluster.

Responses

200 application/json

Successfully retrieved.
Hide response attributes Show response attributes object
- service_id string
  
  The Service ID for the currently synced cluster, if there is one.
- partition_fields array[object]
  
  A list of valid partition keys based on the cluster's collection schemas.
  
  Hide partition_fields attributes Show partition_fields attributes object
  
  key string
  
  type string

GET /groups/{groupId}/apps/{appId}/sync/data

curl \
 --request GET 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/sync/data?service_id=string' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "service_id": "string",
  "partition_fields": [
    {
      "key": "string",
      "type": "string"
    }
  ]
}