On this page

Root Configuration

Atlas Device Sync, Atlas Edge Server, Data API, and HTTPS Endpoints are deprecated. Refer to the deprecation page for details.

You configure Application-level settings like your App name, environment, and deployment configuration in root_config.json.

app/
└── root_config.json

Tip

If you're using the App Services CLI, you can find metadata information about your specific deployed App instance in the .mdb directory.

Root Configuration

Your configuration directory must include a root_config.json file with the following structure:

/root_config.json

{
  "name": "<App Name>",
  "deployment_model": "<Deployment Model Type>",
  "provider_region": "<Cloud Provider Region Name>",
  "environment": "<Environment Name>",
  "allowed_request_origins": ["<Request Origin URL>", ...]
}

Field

Description

name

string

The application's name.

Note

App Name Limitations

Application names must be between 1 and 32 characters and may only contain ASCII letters, numbers, underscores, and hyphens.

deployment_model

string

The application's deployment model.

Valid options:

"GLOBAL" for Global Deployment
"LOCAL" for Local Deployment

provider_region

string

The name of the cloud region that the application is deployed in.

Global applications process all database writes in this region, but serve other application requests in the nearest deployment region.
Local applications process all application requests and database writes in this region.

environment

string?

The name of the environment the app should use when evaluating environment values.

Valid options:

""
"development"
"testing"
"qa"
"production"

Default: ""

allowed_request_origins

string[]?

An array of URLs that incoming requests may originate from. If you define any allowed request origins, then Atlas App Services blocks any incoming request from an origin that is not listed.

Tip

Request origins are URLs with the following form:

<scheme>://<host>[:port]

For example, the following are both valid request origins:

https://www.example.com
https://www.example.com:443

Back

App Configuration Files

Users & Authentication Providers