Mendix

Mendix Packages API

The Packages API from Mendix — 3 operation(s) for packages.

GitHub OpenAPI

Operations 3

GET /apps/{AppId}/environments/{Mode}/package Get deployed package
POST /apps/{AppId}/packages/upload Upload deployment package
POST /apps/{AppId}/environments/{Mode}/transport Transport package to environment

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/mendix/refs/heads/main/openapi/mendix-packages-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-packages-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-packages-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Mendix Deploy API v1 Apps Packages 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: Packages
paths:
  /apps/{AppId}/environments/{Mode}/package:
    parameters:
    - $ref: '#/components/parameters/AppId'
    - $ref: '#/components/parameters/Mode'
    get:
      tags:
      - Packages
      summary: Get deployed package
      responses:
        '200':
          description: Deployed package details
  /apps/{AppId}/packages/upload:
    parameters:
    - $ref: '#/components/parameters/AppId'
    post:
      tags:
      - Packages
      summary: Upload deployment package
      responses:
        '200':
          description: Package uploaded
  /apps/{AppId}/environments/{Mode}/transport:
    parameters:
    - $ref: '#/components/parameters/AppId'
    - $ref: '#/components/parameters/Mode'
    post:
      tags:
      - Packages
      summary: Transport package to environment
      responses:
        '200':
          description: Transport accepted
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.

        '