Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 28 additions & 6 deletions content/en/docs/apidocs-mxsdk/apidocs/deployment/backups-api-v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,24 +21,46 @@ You cannot currently upload an archive through this API. This function is curren

This API focuses on working with snapshots and archives asynchronously, because these can be very long-running tasks for large quantities of data. It replaces the deprecated Backups API v1.

## Authentication
## Authentication{#authentication}

The Backups API requires authentication via API keys that are bound to your Mendix account.
The Backups API supports authentication via a personal access token (PAT) or an API key. Mendix recommends using a PAT.

### Obtaining an API Key
{{% alert color="warning" %}}
{{% snippet file="/static/_includes/apidocs-mxsdk/api-key-deprecation-warning.md" %}}
{{% /alert %}}

To obtain a Mendix API key, follow the instructions in the [API Keys](/portal/user-settings/#profile-api-keys) section of *Mendix Profile*.
### Authenticating with a PAT{#authenticating-with-pat}

For details on how to generate a PAT, see the [Personal Access Tokens](/portal/user-settings/#pat) section of *Mendix Profile*.

Select at least the following scopes:

* `mx:deployment:read` – to perform `GET` operations
* `mx:deployment:write` – to perform all operations (`GET`, `POST`, `PUT`, and `DELETE`)

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

### Using Authentication Headers
```http
GET /api/v2/apps/543857rfds-dfsfsd12c5e24-3224d32eg/environments/cd5fc610-edb0-43c5-a374-0439a6411ace/snapshots HTTP/1.1
Authorization: MxToken 7LJE…vk
```

### Authenticating with an API Key{#authenticating-with-api-key}

To obtain a Mendix API key, follow the instructions in the [API Keys](/portal/user-settings/#profile-api-keys) section of *Mendix Profile*.

Use the following request headers to authenticate an API call:

* `Mendix-Username` – the login name of the requesting user with the required privileges in the Mendix Platform
* `Mendix-ApiKey` – the API key of this user

### Migrating from an API Key to a PAT{#migrate-to-pat}

{{% snippet file="/static/_includes/apidocs-mxsdk/migrate-api-key-to-pat.md" %}}

### Configuring Permissions

To perform an action via the Backups API, you need **Backups Access** and **API Access** permissions. This can be configured from the [Permissions tab](/developerportal/deploy/node-permissions/#permissions-tab) of your app's **Environments** page.
To perform an action via the Backups API, you need **Backups Access** and **API Access** permissions. These permissions are required whether you authenticate with a PAT or an API key. PAT scopes alone are not enough. This can be configured from the [Permissions tab](/developerportal/deploy/node-permissions/#permissions-tab) of your app's **Environments** page.

## Examples

Expand Down
33 changes: 28 additions & 5 deletions content/en/docs/apidocs-mxsdk/apidocs/deployment/build-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,21 +20,44 @@ The image below provides a domain model representation of the concepts discussed

{{< figure src="/attachments/apidocs-mxsdk/apidocs/build-api/api-model.png" class="no-border" >}}

## Authentication
## Authentication{#authentication}

The Build API requires authentication via API keys that are bound to your Mendix account.
The Build API supports authentication via a personal access token (PAT) or an API key. Mendix recommends using a PAT.

### Obtaining an API Key
{{% alert color="warning" %}}
{{% snippet file="/static/_includes/apidocs-mxsdk/api-key-deprecation-warning.md" %}}
{{% /alert %}}

To obtain a Mendix API key, follow the instructions in the [API Keys](/portal/user-settings/#profile-api-keys) section of *Mendix Profile*.
### Authenticating with a PAT{#authenticating-with-pat}

For details on how to generate a PAT, see the [Personal Access Tokens](/portal/user-settings/#pat) section of *Mendix Profile*.

Select at least the following scopes:

* `mx:build:read` – to read build information
* `mx:build:write` – to trigger and manage builds

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

```http
GET /api/1/apps/calc/packages HTTP/1.1
Host: deploy.mendix.com
Authorization: MxToken 7LJE…vk
```

### Using Authentication Headers
### Authenticating with an API Key{#authenticating-with-api-key}

To obtain a Mendix API key, follow the instructions in the [API Keys](/portal/user-settings/#profile-api-keys) section of *Mendix Profile*.

Use the following request headers to authenticate an API call:

* `Mendix-Username` – the login name of the requesting user with the required privileges in the Mendix Platform
* `Mendix-ApiKey` – the API key of this user

### Migrating from an API Key to a PAT{#migrate-to-pat}

{{% snippet file="/static/_includes/apidocs-mxsdk/migrate-api-key-to-pat.md" %}}

### Configuring Permissions

To perform an action via the Build API, you need **API Access** permissions. This can be configured from the [Permissions tab](/developerportal/deploy/node-permissions/#permissions-tab) of your app's **Environments** page.
Expand Down
32 changes: 28 additions & 4 deletions content/en/docs/apidocs-mxsdk/apidocs/deployment/deploy-api-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,19 +32,43 @@ This image provides a domain model representation of the concepts discussed belo

## Authentication{#authentication}

The Deploy API v1 requires authentication via API keys that are bound to your Mendix account.
The Deploy API v1 supports authentication via a personal access token (PAT) or an API key. Mendix recommends using a PAT.

### Obtaining an API Key
{{% alert color="warning" %}}
{{% snippet file="/static/_includes/apidocs-mxsdk/api-key-deprecation-warning.md" %}}
{{% /alert %}}

To obtain a Mendix API key, follow the instructions in the [API Keys](/portal/user-settings/#profile-api-keys) section of *Mendix Profile*.
### Authenticating with a PAT{#authenticating-with-pat}

For details on how to generate a PAT, see the [Personal Access Tokens](/portal/user-settings/#pat) section of *Mendix Profile*.

### Using Authentication Headers
Select at least the following scopes:

* `mx:deployment:read` – to perform `GET` operations
* `mx:deployment:write` – to perform all operations (`GET`, `POST`, `PUT`, and `DELETE`)
* `mx:build:read` – to read build information
* `mx:build:write` – to trigger and manage builds

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

```http
GET /api/1/apps HTTP/1.1
Authorization: MxToken 7LJE…vk
```

### Authenticating with an API Key{#authenticating-with-api-key}

To obtain a Mendix API key, follow the instructions in the [API Keys](/portal/user-settings/#profile-api-keys) section of *Mendix Profile*.

Use the following request headers to authenticate an API call:

* `Mendix-Username` – the login name of the requesting user with the required privileges in the Mendix Platform
* `Mendix-ApiKey` – the API key of this user

### Migrating from an API Key to a PAT{#migrate-to-pat}

{{% snippet file="/static/_includes/apidocs-mxsdk/migrate-api-key-to-pat.md" %}}

### Configuring Permissions

Because APIs are designed for automated systems, the Deploy API does not require two-factor authentication, which is normally required to make changes to production environments. This is a potential security risk. Therefore, API access must be explicitly allowed for team members who want to use the Deploy API.
Expand Down
35 changes: 31 additions & 4 deletions content/en/docs/apidocs-mxsdk/apidocs/deployment/deploy-api-2.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,46 @@ The v2 Deploy API only supports the endpoints listed here. For all other deploym
Mendix recommends using calls from the same version of the API where possible. This is because the naming varies across versions. For example, the `{appId}` in the version 4 API is retrieved as the `{ProjectId}` from the version 1 API.
{{% /alert %}}

The Deploy API v2 requires authentication via API keys that are bound to your Mendix account.
## Authentication{#authentication}

### Obtaining an API Key
The Deploy API v2 supports authentication via a personal access token (PAT) or an API key. Mendix recommends using a PAT.

To obtain a Mendix API key, follow the instructions in the [API Keys](/portal/user-settings/#profile-api-keys) section of *Mendix Profile*.
{{% alert color="warning" %}}
{{% snippet file="/static/_includes/apidocs-mxsdk/api-key-deprecation-warning.md" %}}
{{% /alert %}}

### Authenticating with a PAT{#authenticating-with-pat}

### Using Authentication Headers
For details on how to generate a PAT, see the [Personal Access Tokens](/portal/user-settings/#pat) section of *Mendix Profile*.

Select at least the following scopes:

* `mx:deployment:read` – to perform `GET` operations
* `mx:deployment:write` – to perform all operations (`GET`, `POST`, `PUT`, and `DELETE`)
* `mx:build:read` – to read build information
* `mx:build:write` – to trigger and manage builds

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

```http
GET /api/v2/apps/calc/jobs/66046953-ecf7-4550-a889-4b7e9f1e1705 HTTP/1.1
Host: deploy.mendix.com
Authorization: MxToken 7LJE…vk
```

### Authenticating with an API Key{#authenticating-with-api-key}

To obtain a Mendix API key, follow the instructions in the [API Keys](/portal/user-settings/#profile-api-keys) section of *Mendix Profile*.

Use the following request headers to authenticate an API call:

* `Mendix-Username` – the login name of the requesting user with the required privileges in the Mendix Platform
* `Mendix-ApiKey` – the API key of this user

### Migrating from an API Key to a PAT{#migrate-to-pat}

{{% snippet file="/static/_includes/apidocs-mxsdk/migrate-api-key-to-pat.md" %}}

### Configuring Permissions

Because APIs are designed for automated systems, the Deploy API does not require two-factor authentication, which is normally required to make changes to production environments. This is a potential security risk. Therefore, API access must be explicitly allowed for team members who want to use the Deploy API.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,19 +28,13 @@ Mendix recommends using calls from the same version of the API where possible. T

## Authentication{#authentication}

Authentication for the Deploy API v4 uses a personal access token (PAT).

### Generating a PAT

For details on how to generate a PAT, see the [Personal Access Tokens](/portal/user-settings/#pat) section of *Mendix Profile*.
Authentication for the Deploy API v4 uses a personal access token (PAT). For details on how to generate a PAT, see the [Personal Access Tokens](/portal/user-settings/#pat) section of *Mendix Profile*.

Select at least the following as **Deployment Mendix Cloud** scopes:

* `mx:deployment:read` – to perform `GET` operations
* `mx:deployment:write` – to perform all operations (`GET`, `POST`, `PUT`, and `DELETE`)

Store the generated value `{GENERATED_PAT}` somewhere safe so you can use it to authorize your Mendix Cloud Deploy API calls.

### Using the PAT

Each request must contain an `Authorization` header with the value `MxToken {GENERATED_PAT}`. Here is an example:
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/releasenotes/deployment/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Follow the links in the table below to see the release notes you want:

| Type of Deployment | Last Updated |
| --- | --- |
| [Mendix Cloud](/releasenotes/developer-portal/mendix-cloud/) | October 15, 2026 |
| [Mendix Cloud](/releasenotes/developer-portal/mendix-cloud/) | October 18, 2026 |
| [Mendix on Kubernetes](/releasenotes/developer-portal/mendix-for-private-cloud/) | June 11, 2026 |
| [Mendix on Azure](/releasenotes/developer-portal/mendix-on-azure/) | July 2, 2026 |
| [SAP Business Technology Platform (SAP BTP)](/releasenotes/developer-portal/sap-cloud-platform/) | September 28, 2025 |
Expand Down
15 changes: 15 additions & 0 deletions content/en/docs/releasenotes/deployment/mendix-cloud/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,21 @@ For information on the current status of deployment to Mendix Cloud and any plan

## October 2026

### October 18, 2026

#### New Features

* The [Deploy API v1](/apidocs-mxsdk/apidocs/deploy-api/), [Deploy API v2](/apidocs-mxsdk/apidocs/deploy-api-2/), [Build API](/apidocs-mxsdk/apidocs/build-api/), and [Backups API v2](/apidocs-mxsdk/apidocs/backups-api/) now support authentication with personal access tokens (PATs), in addition to API keys.

#### Fixes

* We fixed an issue where failed deployments were incorrectly logged as successful. Failed deployments are now logged correctly, and a notification banner informs users when a deployment fails. (Tickets #287659, #289294)
* We fixed an issue with backups in sandbox apps that was caused by a missing environment display name. (Ticket #287851)

#### Deprecations

* API keys are now deprecated, and support ends on January 1, 2027 for [Deploy API v1](/apidocs-mxsdk/apidocs/deploy-api/), [Deploy API v2](/apidocs-mxsdk/apidocs/deploy-api-2/), [Build API](/apidocs-mxsdk/apidocs/build-api/), and [Backups API v2](/apidocs-mxsdk/apidocs/backups-api/). To keep using these APIs, [migrate to PATs](/apidocs-mxsdk/apidocs/deploy-api/#migrate-to-pat).

### October 15, 2026

#### New Features
Expand Down
2 changes: 1 addition & 1 deletion layouts/partials/landingpage/latest-releases.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ <h4 class="lp-panel-title">Latest Releases</h4>
</li>
<li class="lp-panel-list">
<a href="/releasenotes/developer-portal/deployment/">Deployment</a>
<p class="rn-date">October 15, 2026</p>
<p class="rn-date">October 18, 2026</p>
</li>
<li class="lp-panel-list">
<a href="/releasenotes/catalog/">Catalog Release 2.150.0</a>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
API keys are deprecated, and support ends on January 1, 2027. To keep using this API, [migrate to personal access tokens (PATs)](#migrate-to-pat).
6 changes: 6 additions & 0 deletions static/_includes/apidocs-mxsdk/migrate-api-key-to-pat.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
To switch an existing integration from an API key to a PAT, do the following:

1. [Generate a PAT](#authenticating-with-pat) with the required scopes.
2. Remove the `Mendix-Username` and `Mendix-ApiKey` headers.
3. Add an `Authorization` header with the value `MxToken {GENERATED_PAT}`.
4. Run your integration to verify that the calls succeed.
Loading