Mendix

Mendix Environments API

The Environments API from Mendix — 8 operation(s) for environments.

GitHub OpenAPI
Business capability
Environment Management BC-4210.20

Operations 9

GET /apps/{AppId}/environments List environments #
GET /apps/{AppId}/environments/{Mode} Get environment #
POST /apps/{AppId}/environments/{Mode}/start Start environment #
GET /apps/{AppId}/environments/{Mode}/start/{JobId} Check environment start status #
POST /apps/{AppId}/environments/{Mode}/stop Stop environment #
POST /apps/{AppId}/environments/{Mode}/clean Clean environment data #
GET /apps/{AppId}/environments/{Mode}/settings Get environment settings #
POST /apps/{AppId}/environments/{Mode}/settings Update environment settings #
POST /apps/{AppId}/environments/{Mode}/scale Scale memory and instances #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/mendix/refs/heads/main/openapi/mendix-environments-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/mendix-environments-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

mendix-environments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Mendix Deploy API v1 Environments API
  description: 'The Mendix Deploy API manages apps, environments, deployment packages,

    transports, logs, scaling, settings, and tags on Mendix Cloud. Authentication

    uses the Mendix-Username and Mendix-ApiKey request headers tied to a Mendix

    user account.'
  version: '1'
  contact:
    name: Mendix
    url: https://docs.mendix.com/apidocs-mxsdk/apidocs/deploy-api/
servers:
- url: https://deploy.mendix.com/api/1
  description: Mendix Cloud Deploy API v1
security:
- mendixApiKey: []
tags:
- name: Environments
paths:
  /apps/{AppId}/environments:
    parameters:
    - $ref: '#/components/parameters/AppId'
    get:
      tags:
      - Environments
      summary: List environments
      responses:
        '200':
          description: Environments
      operationId: getAppsByAppIdEnvironments
      x-operation-id-source: derived
  /apps/{AppId}/environments/{Mode}:
    parameters:
    - $ref: '#/components/parameters/AppId'
    - $ref: '#/components/parameters/Mode'
    get:
      tags:
      - Environments
      summary: Get environment
      responses:
        '200':
          description: Environment
      operationId: getAppsByAppIdEnvironmentsByMode
      x-operation-id-source: derived
  /apps/{AppId}/environments/{Mode}/start:
    parameters:
    - $ref: '#/components/parameters/AppId'
    - $ref: '#/components/parameters/Mode'
    post:
      tags:
      - Environments
      summary: Start environment
      responses:
        '200':
          description: Start job accepted
      operationId: postAppsByAppIdEnvironmentsByModeStart
      x-operation-id-source: derived
  /apps/{AppId}/environments/{Mode}/start/{JobId}:
    parameters:
    - $ref: '#/components/parameters/AppId'
    - $ref: '#/components/parameters/Mode'
    - name: JobId
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Environments
      summary: Check environment start status
      responses:
        '200':
          description: Job status
      operationId: getAppsByAppIdEnvironmentsByModeStartByJobId
      x-operation-id-source: derived
  /apps/{AppId}/environments/{Mode}/stop:
    parameters:
    - $ref: '#/components/parameters/AppId'
    - $ref: '#/components/parameters/Mode'
    post:
      tags:
      - Environments
      summary: Stop environment
      responses:
        '200':
          description: Stopped
      operationId: postAppsByAppIdEnvironmentsByModeStop
      x-operation-id-source: derived
  /apps/{AppId}/environments/{Mode}/clean:
    parameters:
    - $ref: '#/components/parameters/AppId'
    - $ref: '#/components/parameters/Mode'
    post:
      tags:
      - Environments
      summary: Clean environment data
      responses:
        '200':
          description: Clean accepted
      operationId: postAppsByAppIdEnvironmentsByModeClean
      x-operation-id-source: derived
  /apps/{AppId}/environments/{Mode}/settings:
    parameters:
    - $ref: '#/components/parameters/AppId'
    - $ref: '#/components/parameters/Mode'
    get:
      tags:
      - Environments
      summary: Get environment settings
      responses:
        '200':
          description: Settings
      operationId: getAppsByAppIdEnvironmentsByModeSettings
      x-operation-id-source: derived
    post:
      tags:
      - Environments
      summary: Update environment settings
      responses:
        '200':
          description: Updated
      operationId: postAppsByAppIdEnvironmentsByModeSettings
      x-operation-id-source: derived
  /apps/{AppId}/environments/{Mode}/scale:
    parameters:
    - $ref: '#/components/parameters/AppId'
    - $ref: '#/components/parameters/Mode'
    post:
      tags:
      - Environments
      summary: Scale memory and instances
      responses:
        '200':
          description: Scaled
      operationId: postAppsByAppIdEnvironmentsByModeScale
      x-operation-id-source: derived
components:
  parameters:
    AppId:
      name: AppId
      in: path
      required: true
      schema:
        type: string
      description: Sub-domain name of the app.
    Mode:
      name: Mode
      in: path
      required: true
      schema:
        type: string
        enum:
        - Test
        - Acceptance
        - Production
      description: Environment mode.
  securitySchemes:
    mendixApiKey:
      type: apiKey
      in: header
      name: Mendix-ApiKey
      description: 'Mendix API key. Must be paired with a Mendix-Username header containing the

        login name of the user the key belongs to.

        '