Skip to main content
Version: 8.4

Overview

Web Modeler provides a REST API at /api/*. Clients can access this API by passing a JWT access token in an authorization header Authorization: Bearer <JWT>.

note

Ensure you authenticate before accessing the Web Modeler API.

OpenAPI documentation​

A detailed API description is available as OpenAPI specification at https://modeler.camunda.io/swagger-ui/index.html for SaaS and at http://localhost:8070/swagger-ui.html for Self-Managed installations.

API in Postman​

Work with this API in our Postman collection.

Limitations​

When using Web Modeler API:

  • You will not receive a warning when deleting a file, a folder, or a project. This is important, because deletion cannot be undone.
  • You will not receive a warning about breaking call activity links or business rule task links when moving files or folders to another project. Breaking these links is considered harmless. The broken links can be manually removed or restored in Web Modeler. This operation is also reversible - simply move the files or folders back to their original location.

Rate Limiting​

In SaaS, the Web Modeler API uses rate limiting to control traffic. The limit is 240 requests per minute. Surpassing this limit will result into a HTTP 429 Too Many Requests response.

On Self-Managed instances no limits are enforced.

FAQ​

What is the difference between simplePath and canonicalPath?​

In Web Modeler you can have multiple files with the same name, multiple folders with the same name, and even multiple projects with the same name. Internally, duplicate names are disambiguated by unique ids.

The API gives you access to the names, as well as the ids. For example, when requesting a file you will get the following information:

  • simplePath contains the human-readable path. This path may be ambiguous or may have ambiguous elements (e.g. folders) in it.
  • canonicalPath contains the unique path. It is a list of PathElementDto objects which contain the id and the name of the element.

Internally, the ids are what matters. You can rename files or move files between folders and projects and the id will stay the same.

How do I migrate from the beta API to the v1 API?​

To migrate, change the base URL from /api/beta to /api/v1.

Breaking changes
  • GET /api/beta/projects/{projectId}/files was removed. Use POST /api/v1/files/search instead.
  • GET /api/beta/files/{fileId}/milestones was removed. Use POST /api/v1/milestones/search instead.
  • GET /api/beta/projects was removed. Use POST /api/v1/projects/search instead.

Refer to the OpenAPI documentation for details.

info

Web Modeler's beta API is deprecated and will be removed in the 8.5 release of Web Modeler.