API Documentation

Last modified: August 23, 2024

Introduction

The API documentation is divided into the sections described below.

For more information, see API (Application Programming Interface) in the Technology Glossary.

Authentication

Mendix APIs are secured by either API keys or personal access tokens (PATs). Both mechanisms allow clients such as a CI/CD pipeline to consume the platform APIs on behalf of the platform user who created the token. In the document for each API, you can find information about which authentication mechanism that API uses.

The benefit of a PAT compared to an API key is that the platform user can restrict the scope of delegated access to specific APIs by selecting those scopes during PAT generation.

Documents in this Category

  • APIs for Studio Pro

    • Provides the documentation of APIs for Studio Pro, including Extensibility API and Mendix Runtime API.

  • APIs for Frontend

    • Provides the documentation of APIs for frontend, including Client API, Design Properties API, and Pluggable Widgets API.

  • APIs for Apps

    • Provides the documentation of APIs for Apps, including App Repository API, Epics API, Feedback API, Projects API, and Team Server API.

  • APIs for Deployment

    • Provides the documentation of APIs for Deployment, including Backups API, Build API, Deploy API, Mendix for Private Cloud Build API, Mendix for Private Cloud Deploy API, Pipelines API, and Webhooks API.

  • APIs for Governance

    • Provides the documentation of APIs for governance, including User Identifiers API and User Management API.

  • Content API

    • The Content API accesses both public and company-specific Marketplace content information.

  • Catalog APIs

    • The Catalog APIs register data sources from other business applications.