Skip to main content

Configuration

The Camunda Platform REST API connects to several components in your cluster.

Zeebe​

You can configure the Zeebe connection using the following properties:

ZEEBE_CLIENT_CLOUD_CLUSTER_ID SaaS​

ID of the SaaS cluster that Zeebe is part of.

ZEEBE_CLIENT_CLOUD_REGION SaaS​

Region where the SaaS cluster exists.

ZEEBE_CLIENT_CLOUD_CLIENT_ID SaaS​

ID of an API Client with Zeebe scope.

ZEEBE_CLIENT_CLOUD_CLIENT_SECRET SaaS​

Secret belonging to API Client defined by ZEEBE_CLIENT_CLOUD_CLIENT_ID.

ZEEBE_CLIENT_BROKER_GATEWAYADDRESS Self-Managed​

Address of a Zeebe Gateway.

ZEEBE_CA_CERTIFICATE_PATH Self-Managed​

Path to the CA certificate to validate the gateway's certificate chain. The client looks in the system's certificate store instead by default.

ZEEBE_INSECURE_CONNECTION Self-Managed​

Disables secure communication over TLS. Secure communication over TLS is enabled by default.

Other environment variables​

You can also configure the Zeebe connection using any of the Zeebe Client environment variables and the additional configuration options offered by spring-zeebe.

Operate​

You can configure the Operate connection using the following properties:

ZEEBE_CLIENT_CLOUD_CLUSTER_ID SaaS​

ID of the SaaS cluster that Operate is part of.

ZEEBE_CLIENT_CLOUD_REGION SaaS​

Region where the SaaS cluster exists.

ZEEBE_CLIENT_CLOUD_CLIENT_ID SaaS​

ID of an API Client with Operate scope.

ZEEBE_CLIENT_CLOUD_CLIENT_SECRET SaaS​

Secret belonging to API Client defined by ZEEBE_CLIENT_CLOUD_CLIENT_ID.

CAMUNDA_OPERATE_CLIENT_URL Self-Managed​

Base URL of Operate.

CAMUNDA_OPERATE_CLIENT_USERNAME Self-Managed​

Username for simple authentication to Operate.

CAMUNDA_OPERATE_CLIENT_PASSWORD Self-Managed​

Password for simple authentication to Operate.

CAMUNDA_OPERATE_CLIENT_CLIENTID SaaS​

ID of an API Client with Operate scope.

CAMUNDA_OPERATE_CLIENT_CLIENTID Self-Managed​

ID of an Identity API.

CAMUNDA_OPERATE_CLIENT_CLIENTSECRET SaaS​

Secret belonging to API Client defined by CAMUNDA_OPERATE_CLIENT_CLIENTID.

CAMUNDA_OPERATE_CLIENT_CLIENTSECRET Self-Managed​

Secret belonging to Identity API defined by CAMUNDA_OPERATE_CLIENT_CLIENTID.

CAMUNDA_OPERATE_CLIENT_KEYCLOAKREALM Self-Managed​

Keycloak realm that Identity is connected to.

CAMUNDA_OPERATE_CLIENT_KEYCLOAKURL Self-Managed​

URL of Keycloak.

Next steps​