runtime-admin-api

Runtime Admin API Skill

This skill documents the Mendix M2EE admin API exposed on port 8090, including how to call it directly with curl.

When to Use This Skill

Use this when:

• The user wants to query the running Mendix app directly (OQL, runtime info)
• The user needs to debug connectivity to the admin port
• The user wants to call the M2EE admin API from scripts or external tools
• The user asks about the Mendix admin console or management API

Admin API Overview

The Mendix runtime exposes an HTTP admin API on port 8090 (configurable via ADMIN_PORT in .docker/.env). This API is used by the Mendix Cloud, M2EE tools, and mxcli oql to manage and query the runtime.

Default credentials (from .docker/.env):

• Port: 8090
• Password: AdminPassword1!
• Auth method: X-M2EE-authentication header with the password base64-encoded

Authentication

All requests require the X-M2EE-authentication header containing the base64-encoded admin password:

# Encode the password
echo -n 'AdminPassword1!' | base64
# Result: QWRtaW5QYXNzd29yZDEh

The header value is base64(password) — NOT base64(user:password) (this is not HTTP Basic Auth).

curl Examples

OQL Query (Read-Only Preview)

Mendix 11.11 changed the wire protocol. OQL preview moved off the M2EE action dispatch onto a dedicated REST endpoint POST /dev/preview_execute_oql, where the request body is the params object directly and the response is {"data":[...]} (no action/params wrapper, no feedback envelope). The auth header is unchanged. mxcli oql tries this endpoint first and falls back to the legacy action below on a 404 (older runtimes), so it works on both.

11.11+ (new endpoint):

curl -sf -X post http://localhost:8090/dev/preview_execute_oql \
  -H 'Content-Type: application/json' \
  -H "X-M2EE-authentication: $(echo -n 'AdminPassword1!' | base64)" \
  -d '{"oql":"SELECT Name FROM System.User","numberHandling":"asString"}'
# -> {"data":[{"Name":"MxAdmin"}, ...]}