Skip to main content
To interface with the Sidecar service API, use the Sidecar SDK. For details, see:

Sidecar SDK

 The SDK exposes a convenient stigg.api field which returns the same client as the Stigg.create_client SDK function. You can:
  • Use stigg.api wherever you would otherwise use Stigg.create_client
  • Rely on exactly the same interface and behavior
  • Know that the Sidecar SDK depends on the same underlying API client and simply exposes it for convenience
Since Sidecar SDK version 3.0.0, the TLS connection method has been deprecated in favor of non-TLS. Please ensure you are running a compatible Sidecar image version 2.494.0 or later. For backwards compatibility details, check the changelog. TLS self-signed certificates will expire on January 26, 2026, so upgrading the Sidecar image is strongly recommended.

​
Available options

Execution of the Sidecar service can be customized using the following environment variables:
​
SERVER_API_KEY
string
required
The server API key of the environment.
​
API_URL
string
default:"https://api.stigg.io"
The URL of the Stigg API.
​
EDGE_ENABLED
boolean
default:"true"
Whether entitlements will be accessed from Edge.
​
EDGE_API_URL
string
default:"https://edge.api.stigg.io"
The Edge URL from which entitlements will be accessed.
​
WS_ENABLED
boolean
default:"true"
Whether to listen for updates using WebSockets.
​
WS_URL
string
default:"wss://api.stigg.io"
The WebSocket API URL.
​
REDIS_ENVIRONMENT_PREFIX
string
Identifier of the environment, used to prefix the keys in Redis. If provided, Redis will be used as the cache layer.
​
REDIS_HOST
string
default:"localhost"
Redis host.
​
REDIS_PORT
number
default:"6379"
Redis port.
​
REDIS_DB
number
default:"0"
Redis DB identifier.
​
REDIS_USERNAME
string
Redis username.
​
REDIS_PASSWORD
string
Redis password.
​
REDIS_TLS
boolean
default:"0"
Redis use TLS encryption. (Default=0)
​
REDIS_KEYS_TTL_IN_SECS
number
default:"604800 (7 days)"
Time period for Redis to keep the data before eviction in seconds.
​
ENTITLEMENTS_FALLBACK
string
Global entitlement fallback strategy in JSON format.
​
GRPC_PORT
number
default:"80"
Service port (HTTP/2)
​
PORT
number
default:"8443"
Deprecated TLS service port (HTTP/2 TLS)
​
CACHE_MAX_SIZE_BYTES
number
default:"50% of total available memory size"
Maximum size of the in-memory cache in bytes. If not set, the Sidecar allocates up to 50% of the available memory.
​
HEALTH_ENDPOINT_URL
string
default:"livez"
Health endpoint URL.
​
READY_ENDPOINT_URL
string
default:"readyz"
Ready endpoint URL.
​
METRICS_PORT
number
default:"8080"
The port of the health and metrics endpoints.
​
LOG_LEVEL
string
default:"warn"
Log level, can be one of: error, warn, info, debug.
​
LOG_MESSAGE_KEY
string
default:"msg"
Log string key for the ‘message’ in the JSON object.
​
LOG_ERROR_KEY
string
default:"err"
Log string key for the ‘error’ in the JSON object.
​
OFFLINE
boolean
default:"false"
Enables offline mode for local development.

​
Error handling

When the Sidecar encounters startup errors, such as an invalid API key or network errors to the Stigg API, it continues to run and serves entitlements from the:
  1. Persistent cache (if available)
  2. Global fallback strategy