Catalog APIs

Last modified: October 9, 2024

Introduction

The Catalog APIs are OpenAPI (formerly Swagger) specifications with the following APIs available:

  • Search API — search and retrieve information on registered assets that can be used in your app development
  • Registration API — register and update data sources to the organization’s Catalog
  • Transform API — for Mendix users deploying to a non-Mendix environment, generate the request bodies to register data sources published from your Mendix app

Authentication and Access Rights

The Catalog APIs support OAuth2.0 and personal access tokens. For more information, see the Personal Access Tokens section of Mendix Profile.

To view authentication instructions for each API, open the OpenAPI spec and click Authorize on the upper right of the screen. Supported authentication methods are documented there. As mentioned above, the Try it out feature does not work.

Curation rights apply to some API activities.

The Search API enables users to search and retrieve assets that are registered in the Catalog that satisfy the specified search criteria.

You can paginate through search results with an offset, which allows you to limit the number of results and specify how many to skip.

For step-by-step instructions and an example API call, see the Search Using the API section of Search in the Catalog.

Registration API

The Registration API can be used to register applications, environments, and services or data sources.

The API includes the following:

  • POST methods for registering new assets where a UUID is generated and returned for the asset in the response body
  • PUT calls to update assets for existing UUIDs or create new applications and environments for new UUIDs. If existing endpoints are not present in a PUT call, these endpoints will be deleted.
  • DELETE calls to delete applications

For step-by-step instructions, see the Registering a Service Through the Catalog Registration API section in Register Resources in the Catalog.

Transform API

Mendix users who deploy to non-Mendix clouds can make use of the Transform API to generate the request body for the Registration API. The Transform API reconfigures information from the dependencies.json file into the correct fields. For an example API, see the Preparing Your Service Details Using the Transform API section of Register Resources in the Catalog.

The v5 compatibility for the Transform API is accessible via the Registration API under the Endpoints section.