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.

  One of:

  ServiceConstructor object AtlasFederatedInstanceConstructor object ThirdPartyService object

  Hide attributes Show attributes

  • _id string

    The cluster's unique ID.

  • name string

    The service name.

  • type string

    The type of service.

  Hide attributes Show attributes

  • _id string Required
  • name string Required

    Value is mongodb-datafederation.

  • type string Required

    Value is datalake.

  • config object Required
    Hide config attribute Show config attribute object

    • dataLakeName string Required

      The service name used to refer to the Federated database instance within this Atlas app. The name may be at most 64 characters long and must only contain ASCII letters, numbers, underscores, and hyphens.

  THIRD-PARTY SERVICES ARE DEPRECATED

  See Third-Party Services for more information.

  Hide attributes Show attributes

  • _id string

    A unique ID for the third-party service.

  • name string

    The third-party service name.

  • type string

    The type of third party service.

    Values are aws, twilio, github, or gcm.

  • version integer