environments

Set the App Environment

Set the App's active environment

put/groups/{groupId}/apps/{appId}/environment

Request body

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

The application's environment.

Example request

{
  "environment": "production"
}

Response

Success

namestring

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

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.

_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' | 'device-sync'

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

Changed in 2 of the 50 revisions of this API.816

Feb 20, 2024v3e2240dd053bd86See the full diff
- ▲
  added AppEnvironment subschema #1 to the environment request property allOf list
  request-property-all-of-added
- ▲
  removed the enum value of the request property environment
  request-property-enum-value-removed
- ▲
  removed the enum value development of the request property environment
  request-property-enum-value-removed
- ▲
  removed the enum value production of the request property environment
  request-property-enum-value-removed
- ▲
  removed the enum value qa of the request property environment
  request-property-enum-value-removed
- ▲
  removed the enum value testing of the request property environment
  request-property-enum-value-removed
- ▲
  the environment request property type/format changed from string/ to /
  request-property-type-changed
- ▲
  the allOf[App]/environment response's property type/format changed from string/ to / for status 200
  response-property-type-changed
- ○
  added AppEnvironment subschema #1 to the allOf[App]/environment response property allOf list for the response status 200
  response-property-all-of-added
- ○
  removed the enum value from the allOf[App]/environment response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the development enum value from the allOf[App]/environment response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the production enum value from the allOf[App]/environment response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the qa enum value from the allOf[App]/environment response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the testing enum value from the allOf[App]/environment response property for the response status 200
  response-property-enum-value-removed
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 4, 2023v31d1564c0dca11See the full diff
- ●
  added the new device-sync enum value to the allOf[subschema #2]/product response property for the response status 200
  response-property-enum-value-added

Full history