Sign in
apps

Create a new app

post/groups/{groupId}/apps

Query parameters

defaultsboolean

Whether or not to create a default application.

product'standard' | 'atlas' | 'data-api'

The App's product type. Apps use the standard product type by default. For most apps, you do not need to specify a product at all, or should specify standard.

The atlas and data-api product types represent special, apps for Atlas Triggers and Atlas Data API that you can access through the Atlas UI.

Request body

namestring

The name of the application. Must begin with a letter and may only contain ASCII letters, numbers, underscores, and hyphens.

location'US-VA' | 'US-OR' | 'DE-FF' | 'IE' | 'AU' | 'IN-MB' | 'SG' | 'BR-SP'

An identifier of the location where an app server is physically deployed to, regardless of the cloud provider that hosts the app.

deployment_model'GLOBAL' | 'LOCAL'

An application deployment model.

environment'' | 'development' | 'testing' | 'qa' | 'production'

The application's environment. An empty string indicates that the app does not have a specified environment.

template_idstring

The id of an App Services template app to use as a base for the new app.

Example request

{
  "name": "MyApp",
  "environment": "production",
  "data_source": {
    "name": "mongodb-atlas",
    "type": "mongodb-atlas",
    "config": {
      "clusterName": "Cluster0"
    }
  }
}

Response

The application was successfully created.

namestring

The name of the application. Must begin with a letter and may only contain ASCII letters, numbers, underscores, and hyphens.

location'US-VA' | 'US-OR' | 'DE-FF' | 'IE' | 'AU' | 'IN-MB' | 'SG' | 'BR-SP'

An identifier of the location where an app server is physically deployed to, regardless of the cloud provider that hosts the app.

deployment_model'GLOBAL' | 'LOCAL'

An application deployment model.

environment'' | 'development' | 'testing' | 'qa' | 'production'

The application's environment. An empty string indicates that the app does not have a specified environment.

_idstring

The application's unique internal ID.

client_app_idstring

The application's public App ID.

domain_idstring

The application's associated domain ID.

group_idstring

The application's Atlas Project/Group ID.

last_usedinteger

The time this app was last used in UNIX time (i.e. the number of seconds since Jan 1, 1970).

last_modifiedinteger

The time this app was last modified in UNIX time (i.e. the number of seconds since Jan 1, 1970).

product'standard' | 'atlas' | 'data-api'

The product this app is for.

Example response

{
  "name": "MyApp",
  "environment": "production",
  "_id": "633209ffd3bd3478005d1bac",
  "client_app_id": "myapp-abcde",
  "domain_id": "63320a2b5f9de9a6e0a213e8",
  "group_id": "5b2ec991973129243223a114",
  "last_used": 1664224746,
  "last_modified": 1656440824
}

Changes