Enable/Disable Hosting | MongoDB Atlas App Services Admin API 3.0 documentation

Enable/Disable Hosting Deprecated

PATCH /groups/{groupId}/apps/{appId}/hosting/config

Enable or disable App Services Hosting for your app. Changes to hosting can take up to 15 minutes to take effect. This endpoint does not notify you when the changes have taken effect, only that the change operation was successfully received by the server.

You can see if the hosting enablement/disablement is complete by calling the Get Hosting Configuration endpoint.

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.

application/json

Body

enabled boolean

Set to true to enable App Services Hosting. Set to false to disable App Services Hosting.

Responses

204

Successfully enabled/disabled App Services Hosting.

PATCH /groups/{groupId}/apps/{appId}/hosting/config

curl \
 --request PATCH 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/hosting/config' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"enabled":true}'

Request examples

{
  "enabled": true
}