App Configuration Files

Atlas App Services has reached its end-of-life status and is no longer actively supported by MongoDB. Triggers remain available in the Atlas UI. Refer to the deprecation page for details.

Note

This page describes a legacy configuration file format. You should only use this information if you're using the deprecated realm-cli.

Any configuration files you pull with App Services CLI or export from the UI use the latest configuration version. For detailed information on the current configuration file format, see App Configuration.

You can configure high-level features of your application in realm_config.json.

app/
└── realm_config.json

Configuration

/realm_config.json

{
  "app_id": "<App ID>",
  "name": "<App Name>",
  "config_version": <Version Number>,
  "environment": "<Environment Name>",
  "allowed_request_origins": ["<Origin URL>", ...],
  "deployment_model": "<Deployment Model Type>",
  "location": "<Deployment Cloud Region Name>"
}

Field

Description

app_id

String

The application's App ID.

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.

config_version

Number

The schema version that all configuration files in the application conform to. This value is machine generated and you typically should not manually set or modify it.

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

Document

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]

deployment_model

String

The application's deployment model.

Valid options:

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

location

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.

What are the Atlas Application Services?