Get Hosting Configuration

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

Token auth

Returns the current hosting configuration. Hosting is active if the response includes status: "setup_ok".

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.

Responses

200 application/json

Successfully get hosting configuration
Hide response attributes Show response attributes object
- enabled boolean
- status string
  
  Values are setup_ok, change_in_progress, change_failed, or change_failed_fatal.
- default_domain object
  
  Hide default_domain attributes Show default_domain attributes object
  
  provider_type string
  
  config object
  
  Hide config attribute Show config attribute object
  
  app_default_domain string
  
  Default domain of hosted Atlas App Services App provided by App Services.

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

curl \
 --request GET 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/hosting/config' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "enabled": true,
  "status": "setup_ok",
  "default_domain": {
    "provider_type": "aws",
    "config": {
      "app_default_domain": "myapp-qldqx.mongodbstitch.com"
    }
  }
}