Python — Configuration

SAPIConfig

Field	Type	Description
discoverySvcHosts	list[str]	Network interface addresses and ports used for Discovery.
username	str	Username.
password	str	Password.
listenHosts	list[str]	Hosts for the listening process.
listenPorts	str	Port range for the listening process.
advertiseHosts	list[str]	Advertised hosts.
advertisePorts	str	Advertised ports.
connTimeout	int	Connection timeout.
gatewayStrategy	int	Gateway strategy used for determining destination Gateway.
gatewayHosts	list[str]	Network interface addresses and ports for the Gateway (disables Discovery).
instanceName	str	Process name.
version	int	Code version.
build	str	Build information.
scs	list[str]	Service classes of interest to the client.
retryPolicy	SAPIRetryPolicy	Retry policy.
rtConfig	SAPIRTConfig	RT configuration.
socketConfig	SAPISocketConfig	Socket configuration.
sapiCallbacks	SAPICallbacks	Callback configuration.
domain	str	Domain class.
serviceClass	str	Service class.
family	str	Data family.
addrs	list[str]	Network interface addresses and ports.
udpPort	int	UDP port if used.
gwWorkersCount	int	Number of GW worker threads.
rpWorkersCount	int	Number of RP worker threads.
mqWorkersCount	int	Number of MQ worker threads.
pubWorkersCount	int	Number of Publish worker threads.
dsWorkersCount	int	Number of DS worker threads.
reqMaxPending	int	Maximum number of in‑flight API requests.
reqMaxPendingBlock	bool	Whether to block requests after pending threshold is reached; otherwise reject request.
useTLS	bool	Whether to use TLS for remote process communication.
tls	SAPITLS	TLS settings used for SAPI connections.

SAPIRetryPolicy

Field	Type	Description
maxAttempts	int	Max number of attempts before timeout.
timeout	int	Exit if timeout reached.
retryInterval	int	Interval between attempts, in milliseconds.
retryScaling	float	Retry interval backoff multiplier (must be ≥ 1).

SAPISocketConfig

Field	Type	Description
socRoundTripTime	int	Socket round‑trip time.
socSendRate	int	Socket send rate.
socReceiveRate	int	Socket receive rate.

SAPITLS

Field	Type	Description
CA	str	TLS CA certificate.
CAFile	str	File location of TLS CA certificate. If provided, overrides CA.
cert	str	TLS certificate.
certFile	str	File location of TLS certificate. If provided, overrides cert.
key	str	Certificate key.
keyFile	str	File location of certificate key. If provided, overrides key.
verifyClient	bool	Verify that the certificate provided to incoming connections is valid.
verifyServer	bool	Verify that the certificate provided to outgoing connections is valid.

SAPIRTConfig

Field	Type	Description
useBridge	bool	Whether to use a bridge connection.
configUrl	str	URL or file used to discover endpoint(s). Default: none.
configPath	str	Path for creating local configuration (used if configUrl is null).
clientName	str	Client name.
prefix	str	Prefix.
stream	str	Stream.
clientType	str	Client type.
endPoints	str	Endpoints.
rtPort	str	Real‑time port.
rtDir	str	RT logs directory. Default: /tmp/rt (Linux), c:/Temp/rt (Windows).
CAInfoFile	str	CA cert bundle file path. Default: empty string.
configMaxAge	int	Max age of config details (ms). Default: 300000.
fetchConfigSleep	int	Delay between config reads (ms). Default: 5000.
localPersistencePeriod	int	Local persistence period (ms). Default: 600000.
connTimeout	int	Connection timeout (ms). Default: 2000.
consoleLogLevel	str	Console log level (info/warn/err/off). Default: err.
replFileLogLevel	str	Replicator file log level (trace/debug/info/warn/error/fatal/off). Default: off.
replConsoleLogLevel	str	Replicator console log level (trace/debug/info/warn/error/fatal/off). Default: err.
logLevel	str	General log level (info/warn/err/off). Default: info.
dedupId	str	ID used to deduplicate multiple publishers. Default: none.
logPosition	str	Subscriber start position. Default: 0.
restPortStart	int	Port to start REST server. Default: 0.
pauseThreshold	int	Disk usage threshold (GB) for pausing replication. Default: 0.
exchangeArchived	int	Whether archived events should be sent to server. Default: 0.
truncateArchived	int	Whether archived files should be auto‑truncated. Default: 1.
rtFlushTimeoutSecs	int	Timeout for flushing local logs to server on close. Default: no timeout.
rtLogSizeSoftCap	int	Soft cap for RT log file size. Default: 0.
rtLogSizeHardCap	int	Hard cap for RT log file size. Default: 0.
deleteFiles	int	Whether to delete log files. Default: 0.