MEmendix
apps

Create a new environment for app

Create a new environment with specified configuration and resources for specified app.

post/apps/{appId}/environments

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

Request body

displayNamestring required

Display name of the environment

clusterNamestring required

Cluster name where the environment will be deployed

namespacestring required

Namespace for the environment

storagePlanNamestring required

Name of the storage plan for the environment

databasePlanNamestring required

Name of the database plan for the environment

deploymentPackageNamestring required

Name of the package for the deployment

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

Purpose for the deployment

isExternalSecretStoreEnabled'Yes' | 'No'

Indicate if External Secret Store is enabled for environment configuration, applicable only for Standalone mode cluster.

coreResourcePlanstring

Core Resource Plan for environment creation, it's only for connected mode.

coreResourceSize'Small' | 'Medium' | 'Large'

Core Resource Size for environment, not support Custom Size for environment creation. If need, please use PATCH API to config Custom Size after environment created.

Example request

{
  "displayName": "Env-Dev",
  "clusterName": "cluster-dev",
  "namespace": "namespace-dev",
  "storagePlanName": "storage-dev",
  "databasePlanName": "database-dev",
  "deploymentPackageName": "mh-local-ui102413-5e6a49a5.mda",
  "deploymentPurpose": "Development",
  "coreResourcePlan": "low-level"
}

Response

Response for async operations include create environment, deploy, apply config, start, stop and restart app.

environmentIdstring

Environment id

pipelineIdinteger

Deploy pipeline id

messagestring

operations message

Example response

{
  "environmentId": "j60vwiju",
  "pipelineId": 179862510118532200,
  "message": "Request accepted, deploy app package started"
}

Changes

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