Overview

The Camunda 8 REST API is a REST API designed to interact with a Camunda 8 cluster.

note

Ensure you authenticate before accessing the Camunda 8 REST API.

Context paths

For SaaS: https://${REGION}.zeebe.camunda.io:443/${CLUSTER_ID}/v2/, and for Self-Managed installations: http://localhost:8080/v2/.

note

Find your region and cluster ID under Connection information in your client credentials (revealed when you click on your client under the API tab within your cluster).

For Self-Managed, the host and port depend on your configuration. The context path mentioned here is the default for the Zeebe component.

API Explorer

See the interactive Camunda 8 REST API Explorer for specifications, example requests and responses, and code samples of interacting with the Camunda 8 REST API.

Deployment API

You can change the maxMessageSize default value of 4MB in the Gateway and Broker configuration.

If you do change this value, it is recommended that you also configure the Deploy resources REST endpoint appropriately. By default, this endpoint allows single file upload and overall data up to 4MB.

You can adjust this configuration via the following properties:

spring.servlet.multipart.max-file-size=4MB
spring.servlet.multipart.max-request-size=4MB

For example, if you increase the maxMessageSize to 10MB, increase these property values to 10MB as well.

Query API

danger

Query API endpoints do not currently support resource authorizations, and can be used to expand user access to restricted resources. If you use resource permissions, allowing public access to those endpoints is not recommended.

All Query API endpoints contain an (alpha) declaration. Those endpoints are not accessible by default in Camunda 8 clusters.

You can enable the alpha feature search endpoints by setting either the configuration property camunda.rest.query.enabled to true, or the environment variable CAMUNDA_REST_QUERY_ENABLED to true.