Private Mendix Platform Build API
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 Build API allows you to manage app packages in Private Mendix Platform. You can use the API to do the following:
- Start the build pipeline to create an app package.
- Retrieve all packages for the application.
- Retrieve a specified package for the application.
- Delete a specified package for the application.
- Download a specified package in MDA format.
- Download a specified package in SBOM format.
- Lock or unlock a specified package.