Mendix Pipelines API

Last modified: July 31, 2025

Introduction

The Mendix Pipelines API lets you start a new Mendix Pipeline run for a saved and activated Mendix Pipeline design and retrieve the status of a Mendix Pipeline run.

For details on pipelines, see Mendix Pipelines.

Authentication

Authentication for the Mendix Pipelines API uses a personal access token (PAT).

Generating a PAT

For details on how to generate a PAT, see the Personal Access Tokens section of User Settings.

Select the appropriate scopes, depending on the endpoints that need to be invoked. Refer to the API Reference for more information on which scopes to use in which endpoints.

Store the generated value somewhere safe so you can use it to authorize your API calls.

Using the PAT

Each request must contain an Authorization header with the value MxToken {GENERATED_PAT}. Here is an example:

GET /projects HTTP/1.1
Authorization: MxToken 7LJE…vk

API Reference