Properties reference

Properties for the Camunda Spring SDK.

Properties

• Configuration property
• Environment variable

camunda.client

Properties for the Camunda client.

Property	Description	Default value
camunda.client.ca-certificate-path	The path to a root Certificate Authority (CA) certificate to use instead of the certificate in the default store. Type: string	null
camunda.client.enabled	Enable or disable the Camunda client. If disabled, the client bean is not created. Type: boolean	true
camunda.client.execution-threads	The number of threads for invocation of job workers. Type: integer	1
camunda.client.grpc-address	The gRPC address of Camunda that the client can connect to. The address must be an absolute URL, including the scheme. An alternative default is set by both camunda.client.mode. Type: url	"http://0.0.0.0:26500"
camunda.client.keep-alive	The time interval between keep-alive messages sent to the gateway. Type: duration	null
camunda.client.max-message-size	A custom maxMessageSize sets the maximum inbound message size the client can receive from Camunda. It specifies the maxInboundMessageSize of the gRPC channel. Type: dataSize	"5MB"
camunda.client.max-metadata-size	A custom maxMetadataSize sets the maximum inbound metadata size the client can receive from Camunda. It specifies the maxInboundMetadataSize of the gRPC channel. Type: dataSize	"16KB"
camunda.client.message-time-to-live	The default time-to-live for a message when no value is provided. Type: duration	"PT1H"
camunda.client.mode	The client mode to use. If not set, saas mode is detected based on the presence of a camunda.client.cloud.cluster-id. Type: enum[self-managed, saas]	null
camunda.client.override-authority	Overrides the authority used with TLS virtual hosting to change hostname verification during the TLS handshake. It does not change the actual host connected to. Type: string	null
camunda.client.prefer-rest-over-grpc	If true, prefers REST over gRPC for operations supported by both protocols. Type: boolean	true
camunda.client.request-timeout	The request timeout to use when not overridden by a specific command. Type: duration	"PT10S"
camunda.client.request-timeout-offset	The request timeout client offset applies to commands that also pass the request timeout to the server. It ensures the client timeout occurs after the server timeout. For these commands, the client-side timeout equals the request timeout plus the offset. Type: duration	"PT1S"
camunda.client.rest-address	The REST API address of the Camunda instance that the client can connect to. The address must be an absolute URL, including the scheme. An alternative default is set by bothcamunda.client.mode. Type: url	"http://0.0.0.0:8080"
camunda.client.tenant-id	The tenant ID used for tenant-aware commands when no tenant ID is set. Type: string	"<default>"

camunda.client.auth

Properties for authenticating the Camunda client.

Property	Description	Default value
camunda.client.auth.audience	The resource for which the access token must be valid. A default is set by camunda.client.mode: saas and camunda.client.auth.method: oidc. Type: string	null
camunda.client.auth.client-id	The client ID to use when requesting an access token from the OAuth authorization server. Type: string	null
camunda.client.auth.client-secret	The client secret to use when requesting an access token from the OAuth authorization server. Type: string	null
camunda.client.auth.connect-timeout	The connection timeout for requests to the OAuth credentials provider. Type: duration	"PT5S"
camunda.client.auth.credentials-cache-path	The path to the credentials cache file. Type: string	"$HOME/.camunda/credentials"
camunda.client.auth.keystore-key-password	The keystore key password for the OAuth identity provider. Type: string	null
camunda.client.auth.keystore-password	The keystore password for the OAuth identity provider. Type: string	null
camunda.client.auth.keystore-path	The path to the keystore for the OAuth identity provider. Type: file	null
camunda.client.auth.method	The authentication method to use. If not set, it is detected based on the presence of a username, password, client ID, and client secret. A default is set by camunda.client.mode: saas. Type: enum[none, basic, oidc]	null
camunda.client.auth.password	The password to be use for basic authentication. A default is set by camunda.client.auth.method: basic. Type: string	null
camunda.client.auth.read-timeout	The data read timeout for requests to the OAuth credentials provider. Type: duration	"PT5S"
camunda.client.auth.resource	The resource for which the access token must be valid. Type: string	null
camunda.client.auth.scope	The scopes of the access token. Type: string	null
camunda.client.auth.token-url	The authorization server URL from which to request the access token. A default is set by camunda.client.mode: saas and camunda.client.auth.method: oidc. Type: url	null
camunda.client.auth.truststore-password	The truststore password for the OAuth identity provider. Type: string	null
camunda.client.auth.truststore-path	The path to the truststore for the OAuth identity provider. Type: file	null
camunda.client.auth.username	The username to use for basic authentication. A default is set by camunda.client.auth.method: basic. Type: string	null

camunda.client.auth.client-assertion

Properties for OIDC authentication using a client assertion instead of a client secret.

Property	Description	Default value
camunda.client.auth.client-assertion.keystore-key-alias	The alias of the key containing the certificate used to sign the client assertion certificate. If not set, the first alias from the keystore is used. Type: string	null
camunda.client.auth.client-assertion.keystore-key-password	The password of the key referenced by the alias. If not set, the keystore password is used. Type: string	null
camunda.client.auth.client-assertion.keystore-password	The password of the referenced keystore. Type: string	null
camunda.client.auth.client-assertion.keystore-path	The path to the keystore where the client assertion certificate is stored. Type: file	null

camunda.client.cloud

Properties for connecting the Camunda client to SaaS. These are used to compose default connection details when the client is configured to camunda.client.mode: saas.

Property	Description	Default value
camunda.client.cloud.cluster-id	The cluster ID the Camunda client connects to. Type: string	null
camunda.client.cloud.domain	The domain the Camunda client connects to. Change this to connect to a non-production instance of Camunda Cloud. Type: string	null
camunda.client.cloud.port	The port the Camunda client connects to. Type: integer	null
camunda.client.cloud.region	The region the Camunda client connects to. Type: string	null

camunda.client.deployment

Properties for automatic deployment at startup.

Property	Description	Default value
camunda.client.deployment.enabled	Indicates if deployment uses the @Deployment annotation. Type: boolean	true

camunda.client.worker.defaults

Global default properties for job workers registered to the Camunda client.

Property	Description	Default value
camunda.client.worker.defaults.auto-complete	Enable or disable automatic job completion after method invocation. Type: boolean	null
camunda.client.worker.defaults.enabled	Enable or disable the job worker. Type: boolean	null
camunda.client.worker.defaults.fetch-variables	List of variable names to fetch on job activation. When set in defaults, it extends the list of variables to fetch from the annotation. When set in an override, it replaces the list of variables to fetch. Type: array[string]	null
camunda.client.worker.defaults.force-fetch-all-variables	Sets whether all variables are fetched. Overrides fetch-variables. Type: boolean	null
camunda.client.worker.defaults.max-jobs-active	The maximum number of jobs exclusively activated for this worker at the same time. Type: integer	32
camunda.client.worker.defaults.max-retries	The maximum number of retries before automatic responses (complete, fail, bpmn error) for jobs are no longer attempted. Type: integer	null
camunda.client.worker.defaults.name	The name of the worker owner. If set to default, it is generated as ${beanName}#${methodName}. Type: string	"default"
camunda.client.worker.defaults.poll-interval	The maximal interval between polls for new jobs. Type: duration	"PT0.1S"
camunda.client.worker.defaults.request-timeout	The request timeout for the activate job request used to poll for new jobs. Type: duration	null
camunda.client.worker.defaults.stream-enabled	Opt-in feature flag that enables job streaming. When enabled, the job worker uses both streaming and polling to activate jobs. A long-lived stream eagerly pushes new jobs, and polling retrieves jobs created before any streams were opened. Type: boolean	false
camunda.client.worker.defaults.stream-timeout	If streaming is enabled, sets the maximum lifetime for a stream. When this timeout is reached, the stream closes, and no more jobs are activated or received. If the worker is still open, a new stream opens immediately. Type: duration	null
camunda.client.worker.defaults.tenant-ids	Sets the tenants for which the job worker is registered. When set in defaults, it extends the list of tenant IDs from the annotation. When set in override, it replaces the list of tenant IDs. Type: array[string]	["<default>"]
camunda.client.worker.defaults.timeout	The time a job remains exclusively assigned to the worker. Type: duration	"PT5M"
camunda.client.worker.defaults.type	The type of jobs to work on. Type: string	null

camunda.client.worker.override

Properties for overriding settings of individual job workers registered to the Camunda client. Overrides are specified as key-value pairs, where the key is the worker's job type and the values have the same properties as camunda.client.worker.defaults each: camunda.client.worker.override.<job-type>.<property-name>: <property-value>.

Deprecated properties

caution

The following properties are deprecated. See the replacement property and related hints.

The deprecated properties are still effective if their replacement is not used yet. The SDK hints on the usage of deprecated properties by logging warn statements during startup.

camunda.client

Deprecated properties for the Camunda client.

Property	Replacement	Hint
camunda.client.cluster-id	camunda.client.cloud.cluster-id
camunda.client.region	camunda.client.cloud.region
camunda.client.tenant-ids	camunda.client.worker.defaults.tenant-ids

camunda.client.auth

Deprecated properties for authenticating the Camunda client.

Property	Replacement	Hint
camunda.client.auth.issuer	camunda.client.auth.token-url

camunda.client.cloud

Deprecated properties for connecting the Camunda client to SaaS. These are used to compose default connection details when the client is configured to camunda.client.mode: saas.

Property	Replacement	Hint
camunda.client.cloud.base-url	camunda.client.cloud.domain

camunda.client.identity

Deprecated properties for identity settings.

Property	Replacement	Hint
camunda.client.identity.audience	camunda.client.auth.audience	Identity is now part of Camunda.
camunda.client.identity.base-url		Identity is now part of Camunda.
camunda.client.identity.enabled	camunda.client.enabled	Identity is now part of Camunda.
camunda.client.identity.scope	camunda.client.auth.scope	Identity is now part of Camunda.

camunda.client.zeebe

Deprecated properties for Zeebe client settings.

Property	Replacement	Hint
camunda.client.zeebe.audience	camunda.client.auth.audience
camunda.client.zeebe.base-url	camunda.client.rest-address
camunda.client.zeebe.ca-certificate-path	camunda.client.ca-certificate-path
camunda.client.zeebe.enabled	camunda.client.enabled
camunda.client.zeebe.execution-threads	camunda.client.execution-threads
camunda.client.zeebe.grpc-address	camunda.client.grpc-address
camunda.client.zeebe.keep-alive	camunda.client.keep-alive
camunda.client.zeebe.max-message-size	camunda.client.max-message-size
camunda.client.zeebe.max-metadata-size	camunda.client.max-metadata-size
camunda.client.zeebe.message-time-to-live	camunda.client.message-time-to-live
camunda.client.zeebe.override-authority	camunda.client.override-authority
camunda.client.zeebe.prefer-rest-over-grpc	camunda.client.prefer-rest-over-grpc
camunda.client.zeebe.request-timeout	camunda.client.request-timeout
camunda.client.zeebe.rest-address	camunda.client.rest-address
camunda.client.zeebe.scope	camunda.client.auth.scope

camunda.client.zeebe.defaults

Deprecated default properties for Zeebe job workers.

Property	Replacement	Hint
camunda.client.zeebe.defaults.auto-complete	camunda.client.worker.defaults.auto-complete
camunda.client.zeebe.defaults.enabled	camunda.client.worker.defaults.enabled
camunda.client.zeebe.defaults.fetch-variables	camunda.client.worker.defaults.fetch-variables
camunda.client.zeebe.defaults.force-fetch-all-variables	camunda.client.worker.defaults.force-fetch-all-variables
camunda.client.zeebe.defaults.max-jobs-active	camunda.client.worker.defaults.max-jobs-active
camunda.client.zeebe.defaults.max-retries	camunda.client.worker.defaults.max-retries
camunda.client.zeebe.defaults.name	camunda.client.worker.defaults.name
camunda.client.zeebe.defaults.poll-interval	camunda.client.worker.defaults.poll-interval
camunda.client.zeebe.defaults.request-timeout	camunda.client.worker.defaults.request-timeout
camunda.client.zeebe.defaults.stream-enabled	camunda.client.worker.defaults.stream-enabled
camunda.client.zeebe.defaults.stream-timeout	camunda.client.worker.defaults.stream-timeout
camunda.client.zeebe.defaults.tenant-ids	camunda.client.worker.defaults.tenant-ids
camunda.client.zeebe.defaults.timeout	camunda.client.worker.defaults.timeout
camunda.client.zeebe.defaults.type	camunda.client.worker.defaults.type

camunda.client.zeebe.deployment

Deprecated deployment properties for Zeebe.

Property	Replacement	Hint
camunda.client.zeebe.deployment.enabled	camunda.client.deployment.enabled

camunda.client.zeebe.override

Deprecated properties for overriding individual job workers registered to the Camunda client. Replaced by camunda.client.worker.override.

common

Deprecated common client properties.

Property	Replacement	Hint
common.auth-url	camunda.client.auth.token-url
common.base-url	camunda.client.rest-address
common.client-id	camunda.client.auth.client-id
common.client-secret	camunda.client.auth.client-secret
common.enabled	camunda.client.enabled
common.password	camunda.client.auth.password
common.url	camunda.client.rest-address	The REST address is the unified endpoint for all interaction with Camunda.
common.username	camunda.client.auth.username

common.keycloak

Deprecated Keycloak-specific properties.

Property	Replacement	Hint
common.keycloak.realm		There is no keycloak-specific configuration for Camunda; the issuer is provided as a URL.
common.keycloak.token-url	camunda.client.auth.token-url	There is no keycloak-specific configuration for Camunda; the issuer is provided as a URL.
common.keycloak.url	camunda.client.auth.token-url	There is no keycloak-specific configuration for Camunda; the issuer is provided as a URL.

zeebe.client

Deprecated Zeebe client properties.

Property	Replacement	Hint
zeebe.client.apply-environment-variable-overrides		Only the environment variables belonging to the Spring SDK are applied.
zeebe.client.connection-mode	camunda.client.mode	Client modes are now available.
zeebe.client.default-job-worker-stream-enabled	camunda.client.worker.defaults.stream-enabled
zeebe.client.default-job-worker-tenant-ids	camunda.client.worker.defaults.tenant-ids
zeebe.client.default-tenant-id	camunda.client.tenant-id
zeebe.client.enabled	camunda.client.enabled
zeebe.client.request-timeout	camunda.client.request-timeout

zeebe.client.broker

Deprecated Zeebe broker properties.

Property	Replacement	Hint
zeebe.client.broker.gateway-address	camunda.client.grpc-address
zeebe.client.broker.grpc-address	camunda.client.grpc-address
zeebe.client.broker.keep-alive	camunda.client.keep-alive
zeebe.client.broker.rest-address	camunda.client.rest-address

zeebe.client.cloud

Deprecated Zeebe cloud connection properties.

Property	Replacement	Hint
zeebe.client.cloud.auth-url	camunda.client.auth.token-url
zeebe.client.cloud.base-url	camunda.client.cloud.domain
zeebe.client.cloud.client-id	camunda.client.auth.client-id
zeebe.client.cloud.client-secret	camunda.client.auth.client-secret
zeebe.client.cloud.cluster-id	camunda.client.cloud.cluster-id
zeebe.client.cloud.credentials-cache-path	camunda.client.auth.credentials-cache-path
zeebe.client.cloud.port		The Zeebe client URL is now configured as HTTP/HTTPS URL.
zeebe.client.cloud.region	camunda.client.cloud.region
zeebe.client.cloud.scope	camunda.client.auth.scope

zeebe.client.job

Deprecated Zeebe job worker properties.

Property	Replacement	Hint
zeebe.client.job.poll-interval	camunda.client.worker.defaults.poll-interval
zeebe.client.job.timeout	camunda.client.worker.defaults.timeout

zeebe.client.message

Deprecated Zeebe message properties.

Property	Replacement	Hint
zeebe.client.message.max-message-size	camunda.client.max-message-size
zeebe.client.message.time-to-live	camunda.client.message-time-to-live

zeebe.client.security

Deprecated Zeebe security properties.

Property	Replacement	Hint
zeebe.client.security.cert-path	camunda.client.ca-certificate-path
zeebe.client.security.override-authority	camunda.client.override-authority
zeebe.client.security.plaintext		plaintext is now determined by the URL protocol (HTTP or HTTPS).

zeebe.client.worker

Deprecated Zeebe job worker properties.

Property	Replacement	Hint
zeebe.client.worker.default-name	camunda.client.worker.defaults.name
zeebe.client.worker.default-type	camunda.client.worker.defaults.type
zeebe.client.worker.max-jobs-active	camunda.client.worker.defaults.max-jobs-active
zeebe.client.worker.threads	camunda.client.execution-threads

zeebe.client.worker.override

Deprecated properties to override the individual job workers registered with the Camunda client. Replaced by camunda.client.worker.override.