apps

Update configuration of a specified environment

Update configuration and settings of a specified environment for specified app.

patch/apps/{appId}/environments/{environmentId}/configurations

Request

Base URL
https://pmp-demo.privateplatform.mendix.com/deployservice/v1
Auth
- HTTP basic
- or API key in header Authorization

Path parameters

appIdstring required

App Id

environmentIdstring required

Environment id

Request body

displayNamestring

Display name of the environment

dtapModestring

DTAP mode of the environment can be Development or Production

replicasinteger

Replicas of the environment

appUrlstring

URL of the app deployed in the environment

clientIdForSecretStorestring

Client ID for access external secret store

adminPasswordstring

Admin password of the app deployed in the environment

isAdminPasswordSecretStore'Yes' | 'No'

Indicate if Admin Password is stored as external secret, applicable only for Standalone mode cluster.

leaderlessMode'Yes' | 'No'

Indicate if the environment is in leaderless mode

Example request

{
  "displayName": "Env-Dev",
  "dtapMode": "Development",
  "replicas": 1,
  "appUrl": "https://project-a-env.portunus.mxplatform.net/",
  "clientIdForSecretStore": "[ClientIdForAzureKeyVault]",
  "adminPassword": "[MxAdminPassword]",
  "leaderlessMode": "No"
}

Response

Environment detail information

environmentIdstring

Environment id

internalNamestring

Internal name of the environment

displayNamestring

Display name of the environment

clusterNamestring

Name of the cluster for the environment created

namespacestring

Cluster namespace for the environment created

storagePlanNamestring

Name of the storage plan for the environment

databasePlanNamestring

Name of the database plan for the environment

deploymentPurpose'Development' | 'Test' | 'Acceptance' | 'Production'

Purpose of the deployment

dtapModestring

DTAP mode of the environment can be Development or Production

appNamestring

Name of the application

appUrlstring

URL of the application

clientIdForSecretStorestring

Client ID for access external secret store

isExternalSecretStoreEnabledstring

Indicates if external secret store is enabled

isAdminPasswordSecretStorestring

Indicates if admin password is stored as external secret

Status of the environment

readyReplicasinteger

Number of ready replicas for the environment

replicasinteger

Total number of replicas for the environment

isAppStoppedboolean

Indicates if the application is stopped

isManualDeployboolean

Indicates if the deployment was manual

leaderlessModestring

Indicates if the environment was leaderless mode

buildStatusstring

Status of the build process

runtimeStatusstring

Status of the runtime environment

networkStatusstring

Status of the network configuration

databaseStatusstring

Status of the database connection

storageStatusstring

Status of the storage configuration

licenseStatusstring

Status of the license

creationStatusstring

Status of the creation process

resourceStatusstring

Status of the resources

runtimeVersionstring

Version of the runtime environment

lastStartTimestring

Timestamp of the last start time

buildExplanationstring

Explanation for the build process

storageExplanationstring

Explanation for the storage configuration

runtimeExplanationstring

Explanation for the runtime environment

Example response

{
  "environmentId": "eynu0q2x",
  "internalName": "eynu0q2x",
  "displayName": "Env-Dev",
  "clusterName": "test-cluster",
  "namespace": "test-namespace",
  "storagePlanName": "test-storage-plan",
  "databasePlanName": "test-database-plan",
  "deploymentPurpose": "Development",
  "dtapMode": "Development",
  "appName": "MyApp",
  "appUrl": "https://myapp.example.com",
  "clientIdForSecretStore": "[ClientIdForAzureKeyVault]",
  "isExternalSecretStoreEnabled": "Yes",
  "isAdminPasswordSecretStore": "Yes",
  "status": "Success",
  "readyReplicas": 2,
  "replicas": 3,
  "isManualDeploy": true,
  "leaderlessMode": "Yes",
  "buildStatus": "Processing",
  "runtimeStatus": "Ready",
  "networkStatus": "Ready",
  "databaseStatus": "Ready",
  "storageStatus": "Ready",
  "licenseStatus": "Licensed",
  "creationStatus": "Completed",
  "resourceStatus": "Allocated",
  "runtimeVersion": "1.0.0",
  "lastStartTime": "2023-10-01T12:00:00Z",
  "buildExplanation": "Build completed successfully",
  "storageExplanation": "Storage is available and properly configured",
  "runtimeExplanation": "Runtime environment is running correctly",
  "Packages": {
    "packageId": "a957ec90-0fb3-4c9a-ace9-89d0fd4f6c2f",
    "packageName": "mh-local-ui102413-5e6a49a5.mda",
    "status": "Success",
    "branch": "main",
    "revision": "5e6a49a5",
    "modelVersion": "5e6a49a5",
    "runtimeVersion": "10.24.13.86719",
    "createdBy": "John",
    "createdTime": "2026-01-07T04:35:57.378Z"
  },
  "Debugger": {
    "isSecretStore": "No"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.