The Camunda platform provides a public API. This section covers the definition of the public API and backwards compatibility for version updates.

Definition of Public API

The Camunda BPM public API is limited to the following items:

Java API:

  • camunda-engine: All non-implementation Java packages (package name does not contain impl)
  • camunda-engine-spring: All non-implementation Java packages (package name does not contain impl)
  • camunda-engine-cdi: All non-implementation Java packages (package name does not contain impl)
  • camunda-commons-typed-values: All non-implementation Java packages (package name does not contain impl)

HTTP API (REST API):

  • camunda-engine-rest: HTTP interface (set of HTTP requests accepted by the REST API as documented in REST API reference. Java classes are not part of the public API.

Backwards Compatibility for Public API

The Camunda versioning scheme follows the MAJOR.MINOR.PATCH pattern put forward by Semantic Versioning. Camunda will maintain public API backwards compatibility for MINOR version updates. Example: Update from version 7.1.x to 7.2.x will not break the public API.

On this Page: