For the complete documentation index, see llms.txt.
Skip to main content
Version: 8.10 (unreleased)

Configuration Reference

The SDK uses environment variables for configuration, matching the JS SDK conventions:

VariableDescriptionDefault
CAMUNDA_REST_ADDRESSCluster REST API address—
CAMUNDA_AUTH_STRATEGYNONE, OAUTH, or BASICAuto-detected
CAMUNDA_CLIENT_IDOAuth client ID—
CAMUNDA_CLIENT_SECRETOAuth client secret—
CAMUNDA_OAUTH_URLOAuth token endpoint—
CAMUNDA_TOKEN_AUDIENCEOAuth audience—
CAMUNDA_OAUTH_GRANT_TYPEOAuth grant typeclient_credentials
CAMUNDA_OAUTH_SCOPEOAuth scope—
CAMUNDA_OAUTH_TIMEOUT_MSOAuth token request timeout (ms)5000
CAMUNDA_OAUTH_RETRY_MAXMax OAuth token fetch retries5
CAMUNDA_OAUTH_RETRY_BASE_DELAY_MSOAuth retry base delay (ms)1000
CAMUNDA_BASIC_AUTH_USERNAMEBasic auth username—
CAMUNDA_BASIC_AUTH_PASSWORDBasic auth password—
CAMUNDA_DEFAULT_TENANT_IDDefault tenant ID<default>
CAMUNDA_SDK_LOG_LEVELLog level (error, warn, info, debug, trace, silent)error
CAMUNDA_SDK_VALIDATIONValidation mode (see below)req:none,res:none
CAMUNDA_SDK_HTTP_RETRY_MAX_ATTEMPTSTotal HTTP retry attempts (initial + retries)3
CAMUNDA_SDK_HTTP_RETRY_BASE_DELAY_MSHTTP retry base backoff (ms)100
CAMUNDA_SDK_HTTP_RETRY_MAX_DELAY_MSHTTP retry max backoff cap (ms)2000
CAMUNDA_SDK_EVENTUAL_POLL_DEFAULT_MSDefault eventual consistency poll interval (ms)500
ZEEBE_REST_ADDRESSAlias for CAMUNDA_REST_ADDRESS—
CAMUNDA_MTLS_CERTInline PEM client certificate—
CAMUNDA_MTLS_KEYInline PEM client private key—
CAMUNDA_MTLS_CAInline PEM CA bundle—
CAMUNDA_MTLS_CERT_PATHPath to client certificate (PEM)—
CAMUNDA_MTLS_KEY_PATHPath to client private key (PEM)—
CAMUNDA_MTLS_CA_PATHPath to CA bundle (PEM)—
CAMUNDA_MTLS_KEY_PASSPHRASEPassphrase for encrypted private key—

For backpressure configuration variables, see Global Backpressure.