environments

Set the App Environment

Changed on

Set the App's active environment

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

Request

  • Base URL
    https://services.cloud.mongodb.com/api/admin/v3.0
  • URL
    https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/environment
  • Auth
    HTTP bearer

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.

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.

_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

  • v3e2240dd053bdRevision changes
    • breaking

      added subschema #1 to the request property allOf list

    • breaking

      removed the enum value of the request property

    • breaking

      removed the enum value development of the request property

    • breaking

      removed the enum value production of the request property

    • breaking

      removed the enum value qa of the request property

    • breaking

      removed the enum value testing of the request property

    • breaking

      the request property type changed from string to no type

    • breaking

      the //// response's property type changed from string to no type for status

    • info

      added subschema #1 to the //// response property allOf list for the response status

    • info

      removed the enum value from the //// response property for the response status

    • info

      removed the development enum value from the //// response property for the response status

    • info

      removed the production enum value from the //// response property for the response status

    • info

      removed the qa enum value from the //// response property for the response status

    • info

      removed the testing enum value from the //// response property for the response status

  • v31d1564c0dca1Revision changes
    • warning

      added the new device-sync enum value to the / response property for the response status