Endpoints

View and manage your app's custom HTTPS endpoints.

HTTPS Endpoint requests use a base URL that's specific to your App and deployment model.

For a globally deployed app, the base URL has the following format:

https://data.mongodb-api.com/app/{ClientAppID}/endpoint

A locally deployed app uses a similar base URL also includes the App's deployment region and cloud provider:

https://{Region}.{Cloud}.data.mongodb-api.com/app/{ClientAppID}/endpoint

You can find an App's Region, Cloud, and ClientAppId by calling the Get an App endpoint:

curl -X GET https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId} \
  -h 'Authorization: Bearer <AccessToken>'

For example, consider an App that has the following configuration:

{
  "client_app_id": "myapp-abcde",
  "deployment_model": "LOCAL",
  "provider_region": "aws-us-east-1",
  ...
}

This App would use the following base URL for incoming custom HTTPS endpoint requests:

https://us-east-1.aws.data.mongodb-api.com/app/myapp-abcde/endpoint