Skip to content

hetida designer REST API

The hetida designer backend and hetida designer runtime offer a comprehensive REST API.

Besides the endpoints necessary for the frontend it includes routes for execution of transformations by external services, maintenance, dashboarding and the builtin scheduling as well as builtin adapters.

Which endpoints are available depends on the role of the running service (backend, runtime, combined) and on its configuration. For example the maintenance endpoints are only active if a maintenance secret is configured and the BLOB storage adapter endpoints only if its hierarchy is configured.

The API is documented via the openapi.json file. It contains all endpoints, including those which are deactivated by default. We recommend to display it with an appropriate openapi viewer application.

View API Online via Swagger Editor