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.

• serviceId string Required

  The unique _id value of a service.

Responses

• 200 application/json

  Successfully retrieved.

  Hide response attributes Show response attributes object

  • clusterId string

    The Service ID for the linked cluster.

  • clusterName string

    The name of the linked cluster

  • clusterType string

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

    Values are atlas or serverless.

  • flexible_sync object
    Hide flexible_sync attributes Show flexible_sync attributes object

    • state string Required

      The state of the sync service ("enabled", "disabled", or empty if Sync is not configured).

    • database_name string

      The name of a database in the synced cluster where App Services stores data in Development Mode. App Services automatically generates a schema for each synced type and maps each object type to a collection within the database.

    • queryable_fields_names array[string]

      An array of queryable field names on any collection.

    • indexed_queryable_fields_names array[string]

      A list of field names to use as the indexed queryable field. Although this property is an array, Sync currently supports only one indexed queryable field. Therefore, this array may contain at most one element.

      The indexed queryable field must be present in the schema and be the same eligible field type in every collection you sync. The indexed queryable field name must also appear in queryable_fields_names since this is a global queryable field.

    • collection_queryable_fields_names object

      An array of queryable field names on the specified collection.

      Hide collection_queryable_fields_names attribute Show collection_queryable_fields_names attribute object

      • * object Additional properties
        Hide * attribute Show * attribute object

        • * string Additional properties

          The name of the queryable field.

    • permissions object

      Deprecated

    • last_disabled string

      The last time Sync was disabled, represented by the number of seconds since the UNIX epoch.

    • client_max_offline_days integer

      The number of days the client can be offline before a client reset is required.

    • is_recovery_mode_disabled boolean

      Specifies whether the client reset mode is disabled. By default, client reset mode is enabled and this value is false.

    • asymmetric_tables array[string]

      An array of the names of collections that are defined as asymmetric with Data Ingest, where clients can write data but not read.

  • groupName string

    The name of the App's Atlas Project.

  • orgName string

    The name of the App's Atlas Organization.

  • readPreference string

    Values are primary, primaryPreferred, secondary, secondaryPreferred, or nearest.

  • wireProtocolEnabled boolean

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