API Documentation

Describes the two methods of Mendix API authentication: using API keys and using personal access tokens.

This API enables retrieving information (branches, commits) of application models stored in the Mendix Team Server.

An API to allow the triggering of backups creation, restore, download and to get information about existing snapshots.

An API that enables triggering and managing deployment package builds and getting information about existing deployment packages.

Describes the Catalog APIs (which are for registering data sources from other business applications) and how to generate the personal access token.

This API enriches the user interface of your applications by building on top of the Mendix web Client APIs.

This API allows you to access both public and company-specific Marketplace content information.

This API can be used to deploy Mendix apps to licensed nodes, manage application environments in Mendix Cloud, retrieve statuses, start and stop applications, and deploy or transport new model versions to application environments.

The Deploy API v2 can be used to deploy Mendix apps to licensed nodes, manage application environments in Mendix Cloud, retrieve statuses, start and stop applications, and deploy or transport new model versions to application environments.

Deploy API v4 can be used to deploy Mendix apps to licensed nodes, manage application environments in Mendix Cloud, retrieve statuses, start and stop applications, and deploy or transport new model versions to application environments.

This API guide outlines how design properties work in Atlas UI and can help you create custom design properties.

Use this API to extend the requirements and project management capabilities of the Mendix Platform or connect third-party service management and project management tools.

Describes the Studio Pro Extensibility API.

This API is deprecated. This document presents details for using this API to build on top of the feedback management functionality of the Mendix Platform and to connect your own feedback gathering tool.

Describes how to use Feedback API version 2, which allows you to retrieve, add, and manage feedback for your Mendix apps.

This API allows you to manage deployment packages which can later be used in the environments deployed in your private cloud.

This API allows you to manage application environments deployed to your private cloud using the Mendix Operator.

All the functionality and information from both the application model and Mendix Runtime is accessible via this API.

Describes how to use the Mendix SDKs to gain access to the inner-workings of a Mendix app.

This API is deprecated. With this API, you can retrieve the user roles of your app users so that you can grant them specific access levels.

This API helps you to understand pluggable widgets, how they extend app functionality, and how they can be built to interact with Mendix’s APIs in Mx10.

Presents an overview of the Private Mendix Platform API documentation, such as Group, User, Marketplace, and Project.

This API allows you to manage your projects and their teams.

This API is deprecated. This API enables retrieving information (branches, revisions) about application models stored in Mendix Team Server.

User Identifiers API allows Mendix Admins to perform operations related to user identifiers belonging to their company.

This API is deprecated. Use this API to integrate your company’s user management systems with the Mendix Platform. You can then create and manage user accounts and groups as well as define group policies for your apps.

Use this API to manage webhooks.