Private Mendix Platform Deploy API - Version 1
Last modified: July 3, 2026
This document is about Private Mendix Platform API. This API is only available on instances of Private Mendix Platform. For Mendix on Kubernetes API, see Mendix on Kubernetes Build API and Mendix on Kubernetes Deploy API.
Introduction
The Private Mendix Platform Deploy API allows you to manage environments in Private Mendix Platform. You can use the API to do the following:
- Create a new environment for the application.
- Retrieve all environments for the application.
- Retrieve a specified environment for the application.
- Update the configuration of a specified environment.
- Delete the configuration and settings of a specified environment.
- Deploy a package or apply changes for a specified environment.
- Get a dashboard with all environments created for the application.