Skip to Content

API gateway configuration file `gatewayconfig.yaml`

Introduction

This page describes the main configuration file for private API gateways, gatewayconfig.yaml. It is found in /usr/local/openresty/nginx/conf/onpremise/ on Linux and Docker.

`gatewayconfig.yaml` keys and values

Key	Default	Description
`APILogPath`	`/usr/local/hostedfiles/apilogs/`	API log file path.
`CloudPassword`	(None)	Jitterbit Harmony account password.
`CloudUser`	(None)	Jitterbit Harmony account login name (usually your email address). The account must have access to your APIs.
`DebugMessageTruncateSize`	`5000`	Truncate messages exceeding this size (in bytes). Do not change unless instructed by Jitterbit support.
`GlobalHitsPerMinuteDefault`	`10`	Global hits per minute limit. Do not change unless instructed by Jitterbit support.
`InfluxDB_pass`	(None)	InfluxDB password.
`InfluxDB_user`	(None)	InfluxDB username.
`LogFile_Detail`	`true`	If `true`, enable detailed logging (showing all fields). Files appear in the directory specified by `APILogPath`.
`LogFile_Enabled`	`true`	If `true`, enable logging.
`LogFile_Format`	`CSV`	Log file format. Possible values: `CSV`, `JSON`.
`LogFile_NewEveryXHours`	`1`	Create a new log file on this hourly period.
`LogFile_Summary`	`false`	If `true`, enable summary logging (showing some fields). Files appear in the directory specified by `APILogPath`.
`LogglyToken`	(None)	Loggly token.
`LogglyURL`	(None)	Loggly URL.
`VerifyPayloadAttempts`	`0`	Number of times to attempt payload verification. If 0, disable payload verification. Can cause performance degradation. Use only for debugging disk issues. Do not change unless instructed by Jitterbit support.
`VerifyPayloadCompression`	`false`	If `true`, verify payload compression. Do not change unless instructed by Jitterbit support.
`VerifyPayloadDelayMs`	`100`	Payload verification delay (milliseconds). Do not change unless instructed by Jitterbit support.
`apicacheInvalidORGsec`	`600`	Metadata cache period (seconds). Do not change unless instructed by Jitterbit support.
`apicachelongexpiresec`	`21600`	Metadata cache period (seconds). Do not change unless instructed by Jitterbit support.
`apicachetimesec`	`300`	Metadata cache period (seconds). Do not change unless instructed by Jitterbit support.
`authTokenCacheExpiration`	`300`	Authorization token expiration period (seconds). Do not change unless instructed by Jitterbit support.
`autodeletepayloadfiles`	`true`	If `true`, automatically delete payload files. Do not change unless instructed by Jitterbit support.
`cloudtimeoutsec`	`30`	Jitterbit connectivity timeout period (seconds). Do not change unless instructed by Jitterbit support.
`corsaccesscontrolmaxage`	`1800`	For internal use. Do not change unless instructed by Jitterbit support.
`deletepayloadfilesaftersec`	`15`	For internal use. Do not change unless instructed by Jitterbit support.
`filecleanupagehours`	`25`	For internal use. Do not change unless instructed by Jitterbit support.
`filecleanupintervalsec`	`3600`	For internal use. Do not change unless instructed by Jitterbit support.
`isonpremise`	`true`	For internal use. Do not change unless instructed by Jitterbit support.
`jbservicesurl`	`https://services.jitterbit.net/apis`	Jitterbit services URL. EMEA customers should set this to `https://services.jitterbit.eu/apis`.
`logcleanupagehours`	`72`	Clean up (delete) log files after this many hours.
`maxpayloadsize`	`20971520`	For internal use. Do not change unless instructed by Jitterbit support.
`nginxinstallpath`	`/usr/local/openresty/nginx/`	Nginx installation location.
`oauthTokenCacheExpireSec`	`300`	OAuth cache expiry. (For performance reasons, OAuth tokens are cached. External validation is done after expiration.) Do not change unless instructed by Jitterbit support.
`orgID`	(None)	Set this if your APIs are not in your default organization.
`payloaddlsizethreshold`	`1000`	For internal use. Do not change unless instructed by Jitterbit support.
`payloadrequestslocalpath`	`/usr/local/hostedfiles/payloads/`	Payload requests path.
`payloadresponseslocalpath`	`/usr/local/hostedfiles/responses/`	Payload response path.
`payloadurlpath`	/`payloads`	For internal use. Do not change unless instructed by Jitterbit support.
`payloadurlprefix`	`https://`	For internal use. Do not change unless instructed by Jitterbit support.
`proxyEnabled`	`false`	If `true`, enable proxy server support.
`proxyIgnoredHosts`	(None)	Comma-separated list of hostnames that should bypass the proxy.
`proxyPassword`	(None)	Proxy server password, base64-encoded.
`proxyUri`	(None)	URI of proxy server, including the port number. (Examples: `http://192.168.1.64:808`, `http://myProxyService.com:808`)
`proxyUser`	(None)	Proxy server username, base64-encoded.
`traceLogsEnabled`	`false`	If `true`, enable trace logging. When enabled, trace logs appear in `/usr/local/openresty/nginx/logs/trace-logs/trace.log`.