Specifies whether the number of records retrieved by Elasticsearch in a single request exceeds the configured value or not.

Possible values:

Specifies the list of restricted file extensions to prevent users from uploading files with those extensions as the input document for an API. For example, a file with the .exe file extension could contain executable code that run on demand when it is downloaded. If files with the .exe file extension are restricted, users cannot upload a file with the .exe extension in API Gateway.

By default, several standard file extensions are blocked, including any file extensions that are treated as executable files by Windows Explorer. The file extensions blocked by default are:

You can remove any or all of the default file extensions.

Specifies the maximum document size, in MB, that can be uploaded as an input document for an API.

Default value is 5.

This prevents users from uploading huge files that might slow down the system.

Specifies the time interval (in seconds) between each interval processor iteration.

The value, you provide, must be an evenly divisible fraction of the smallest policy interval, which is one minute.

Default value is 15.

Specifies whether the incoming API requests must be redirected to the directives /ws and /mediator for providing Mediator compatible endpoints.

Possible values:

Specifies the pool size for the XML schema parsers. API Gateway uses parsers to validate the XML payload against the XML schema when you have selected Schema in the Validate API Specification policy of the API.

The default value is 10. Provide a bigger value to increase the performance of API Gateway in validating the XML schema of APIs.

Specifies the names of API groups. You can organize your APIs by associating them to the relevant API groups. The groups provided, by default, are:

You can add, edit, or delete API groups based on your requirement.

Specifies the time for which an API Key is valid. You can provide the value in seconds, minutes, days, months, or years. For example, 8 seconds, 8s, 10 months, 10m, 15 minutes, 15min.

The expiration date is computed as follows:

If you do not specify a value, then the API key never expires.

Specifies the HTTP header name from which API Gateway retrieves the API key from incoming client requests.

The default value is x-Gateway-APIKey.

Specifies the API maturity state values that can be set for an API. You can search for APIs based on their maturity status.

The default values provided are Beta, Deprecated, Experimental, Production, and Test.

Specifies the file location where the data backup file has to be archived. The default location is SAGInstallPath/profiles/IS_default/workspace/temp/.

The files are saved with the corresponding timestamp in the specified location. Only the run-time events are included in the archives.

Specifies the time interval after which data in the ClusterNotifierCache is considered stale and is removed from the cache.

The default value is 900 seconds. If you provide a non-numeric value, API Gateway interprets the value as the default value of 900 seconds. If you provide a value less than 60 seconds, API Gateway interprets the value as the lower limit of 60 seconds.

The ClusterNotifierCache maintains a data structure which has an entry for each active member in a cluster. This data structure is used to communicate changes on API definitions, applications, policies, and so on, between the cluster members. When a cluster member shuts down gracefully it removes its entry from the data structure. However, when a cluster member process is killed the entry remains, and other cluster members continue posting notifications to the entry. In order to avoid endless growing resulting in performance degradation the cluster data structure is monitored for absent cluster members. If a cluster member has not reacted within the configured clusterNotifierCacheStaleInterval it is regarded as stale, and its data is removed from the ClusterNotifierCache.

Specifies the header name of the request header in which the client certificate can be passed. API Gateway checks for the existence of this header and fetches the certificate and identifies the application.

The default value is X-Client-Cert.

The certificate included in the custom header can be in the following formats:

PEM formatted certificates are defined to be Base64 encoded. Here, the certificate with delimiters are Base64 encoded to avoid the stripping off of the delimiters.

Specifies whether the encoded characters of URL in the incoming client requests must be decoded or not. The URLs are encoded as per the URI specs or user's requirements.

Possible values:

Specifies the format for encoding the design time and run time invocation data.

The default value is UTF-8.

If you want to modify this value, Software AG recommends that you do it before starting API Gateway.

You can change the value in the gateway-core.xml file located in the folder: SAGInstallDir\IntegrationServer\instances\instance-name\packages\WmAPIGateway\config\resources\beans.

The property to be modified is: <entry key="defaultEncoding" value="UTF-8"/>.

Specifies the display language for the user interface of API Gateway. You can change the display language to your preferred language at any time.

The default value is en.

Specifies whether the hot deploy functionality must be enabled or disabled. When this setting is enabled, you can modify APIs that are active.

Possible values:

This parameter provides an option to secure an API before overwriting it.

Available values are:

Specifies whether the Team Support feature in API Gateway is enabled.

Possible values:

For details on the feature, see Team Support.

Specifies the time, in milliseconds, that the search results for each request must be kept active in Elasticsearch.

When the allowExceedMaxWindowSize setting is enabled, the Scroll feature of the Elasticsearch is enabled to allow Elasticsearch to accept multiple search requests and return multiple results. That is, you can perform multiple search requests using the same query till you get the desired number of records from Elasticsearch.

When you send a search request, Elasticsearch returns the result and keeps the result active for the time specified in the esScrollTimeOut setting. If a request exceeds the time specified in the esScrollTimeOut setting, then the subsequent search requests also fail with a Invalid Scroll ID error message. For more information on the Scroll feature, refer https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-body.html#request-body-search-scroll.

Specifies the maximum number of threads to be used for the event data collection pool.

Each thread in this pool is assigned a task of collecting the events like transactions, error and performance metrics, and processing them for sending to destinations such as API Gateway, Elasticsearch, API Portal, and so on.

Specifying more number of threads implies that the processing of events for sending to the desired destinations is faster. At the same time, it increases the usage of system resources, which could result in slower service execution.

This value must be greater than or equal to the value of events.CollectionPool.minThreads.

Default value is 8.

Specifies the minimum number of threads to be used for the event data collection pool.

Each thread in this pool is assigned a task of collecting the events like transaction, error and performance metrics and processing them for sending to the desired destinations such as API Gateway, Elasticsearch, API Portal, and so on.

Specifying less number of threads implies that processing of events for sending to the desired destinations is slower.

Default value is 1.

Specifies the size of the collection queue to be used during event data collection. This is used in connection with the events.collectionPool.minThreads and events.collectionPool.maxThreads settings.

When events like transaction, error events and performance metrics are generated during API invocations, they will be put in the collection queue for further processing. Each thread in the collection pool is assigned a task of collecting these events and processing them for sending to the desired destinations such as API Gateway, Elasticsearch, API Portal, and so on.

If the queue capacity is reached, then any additional event data would be lost. Hence it is better to increase this size when there is an increase in incoming traffic.

Specifying a large collection queue size and small collection thread pool size might cause delay in processing the events data but ensures all the data are processed.

On the other hand, specifying a small collection queue size and large collection thread pool size might cause faster processing of the events data but keeps the CPUs busier and at the same time when the traffic increases there is a possibility of data loss when the collection queue size is full.

Default value is 10000.

Specifies the maximum number of threads to be used for the event data reporting pool.

Each thread in this pool is assigned a task of sending the events like transaction, error and performance metrics to the desired destinations such as API Gateway, Elasticsearch, API Portal, and so on.

Specifying more number of threads implies that sending of events to the desired destinations is faster. At the same time it increases the usage of system resources, which could result in slower service execution.

This value must be greater than or equal to the value of events.ReportingPool.minThreads.

Default value is 4.

Specifies the minimum number of threads to be used for the event data reporting pool.

Each thread in this pool is assigned a task of sending the events like transaction, error and performance metrics to the desired destinations such as API Gateway, Elasticsearch, API Portal, and so on.

Specifying less number of threads implies that sending of events to the desired destinations is slower.

Default value is 2.

Specifies the size of the reporting queue to be used during event data reporting. This is used in connection with the events.reportingPool.minThreads and events.reportingPool.maxThreads settings.

When events like transaction, error events and performance metrics are generated during API invocations, they will be put in the collection queue for further processing. Each thread in the collection pool is assigned a task of collecting these events, processing them and put in the reporting queue for sending to the desired destinations such as API Gateway, Elasticsearch, API Portal, and so on.

If the reporting queue capacity is reached, then any additional event data would be lost. Hence it is better to increase this size when there is an increase in incoming traffic.

Specifying a large reporting queue size and small reporting thread pool size might cause delay in processing the events data but ensures all the data are processed.

On the other hand, specifying a small reporting queue size and large reporting thread pool size might cause faster processing of the events data but keeps the CPUs busier and at the same time when the traffic increases there is a possibility of data loss when the collection queue size is full.

Default value is 5000.

This parameter is required in the case of a paired gateway deployment scenario using an Advanced Edition license at DMZ.

Specifies whether the incoming requests are forwarded to internal APIs that are deployed in the green zone.

Possible values:

Following are the internal APIs and their URIs for which this parameter is required and its value must be set to true:

Specifies whether API Gateway should forward the query parameter sent by client and query parameters configured in Request Processing stage to the native service if the ${sys_resource_path} variable is not present in the Routing policy URL.

Specifies the username of the user who can run IS services via polices configured in API Gateway.

If the Run as User value is included in the policy level for Invoke webMethods IS service section, then the value provided in the policy overrides the user provided in this setting.

If no value is provided in either of the above mentioned fields, then the user authenticated from the incoming request can invoke the IS service.

Specifies the maximum size of the zip file that can be uploaded to create an API from the Create API screen.

Default value is 100000000.

Specifies the maximum number of backups that can be archived. The default value is 10. If you do not provide a value, then infinite number of archives can be stored.

The archives are saved in the location provided in the backupSharedFileLocation setting.

Specifies the maximum number of search results that Elasticsearch can return for a single search request.

Using the index.max_result_window property in Elasticsearch, you can configure the maximum number of records to be retrieved in a single Elasticsearch request. To know more about the property, refer https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html.

Default value is 10000.

If the value configured in the index.max_result_window setting of Elasticsearch is different from that of the default value, then it is recommended that you provide the same value in this field.

If you have a value greater than the configured value, then Elasticsearch displays an error message. Also, you must enable the allowExceedMaxWindowSize setting if the total number of results to be retrieved is more than the value specified here.

For example, if you have specified 1000 in this setting and the total number of records to be retrieved is 20000, then API Gateway sends 20 requests to retrieve all records provided the allowExceedMaxWindowSize setting is enabled. In the above example, if the allowExceedMaxWindowSize setting is not enabled, an error message is displayed as the value is lesser than the default value.

Specifies the list of possible values of the pagination size, that is, number of items listed per page.

The default values displayed for pagination options are 10,20,30,40,50. For example, if you select 20, then 20 items are displayed per page.

For example, if you change the values to 5,10,15,20,25 then pagination options displayed are 5, 10, 15, 20 and 25. So now when you select 15, the items displayed per page would be 15.

On modifying the value, you have to logout and re-login for the changes to reflect.

If you do not provide any value in the paginationPossibleValues field, the default value as configured by the parameter apigw.num.results.pagination in the configuration file located at SAGInstallDir\profiles\IS_default\apigateway\config\uiconfiguration.properties is considered.

Specifies the unique identifier (ID) of an active OpenID Provider.

Specifies the run interval, in minutes, for the Auto Scaler thread.

Default value is 60 minutes.

The Auto Scaler thread checks for system memory load and adjusts the percentage of objects kept in the cache automatically.

Specifies the value used to calculate the average size, in bytes, of the objects that can be loaded into cache.

The default value is 64.

Software AG recommends you not to modify this value.

Specifies the run interval, in minutes, for the bounded cache resize thread.

The default value is 30 minutes.

The bounded cache stores a predefined number of objects in memory. The cache value is configured in terms of percentage and it varies based on the new objects added to database. The bounded cache resize thread computes the memory size at the configured interval. For example, if you specify 50, the cache memory is calculated once every 50 minutes.

Specifies the maximum number of objects that can kept in the unbounded cache memory.

The default value is 1048576.

Internally, unbounded cache is also a bounded cache with a configured maximum limit.

Specifies the minimum cache percent value. API Gateway maintains the configured memory size. That is, if the value that is computed by the auto scaler thread goes below this value, API Gateway resets the cache percent to the value specified for this setting.

The default value is 20.

The auto scaler thread computes the percentage of objects to be stored in cache. If it computes a lower percentage, say 2%, the value is reset based on the pg_Cache_minCachePercent value.

Specifies the minimum number of objects that are kept in the unbounded cache memory.

The default value is 1024.

For example, if there are 20 objects, and cache size is set to 100%, then the computed cache size is 20. When the actual size becomes lower than the value specified in this setting, then the value is reset to the pg_Cache_minCacheSize value.

Specifies the run interval, in minutes, for the statistics processor thread. The statistics processor thread stores the cache statistics are in Elasticsearch.

The default value is 15 minutes.

The cache statistics analytics page displays details about the cache statistics.

Specifies whether the transport protocol over which the JSON Web Tokens (JWTs) are granted authorization is restricted to HTTPS.

Possible values:

Specifies whether default scopes must be created.

Possible values:

Specifies whether the transport protocol over which the OAuth 2.0 access tokens are granted authorization is restricted to HTTPS.

Possible values:

Specifies the transport protocol over which the OpenID (ID) tokens are granted authorization is restricted to HTTPS.

Possible values:

Specifies whether the xslt doc type declarations must be disabled or not.

Possible values:

Specifies whether the DOM parsing must be enabled.

Possible values:

Specifies whether the use of extensions must be disabled.

Possible values:

This is an internal parameter. Do not modify.

This is an internal parameter. Do not modify.

Specifies the number of milliseconds before an inactive connection to the SNMP target server is closed. If set to 0, the socket remains open indefinitely.

Specifies the maximum size (in bytes) for SNMP traps.

The default value is 10485760.

Specifies the number of times to resend SNMP traps upon failure.

Default value is 1.

This parameter works with pg.cs.snmpTarget.sendTimeOut to determine the delay in re-sending SNMP traps to malfunctioning SNMP servers (that is, it retries*sendTimeOut).

This means that if the retries parameter is set to 3, and the sendTimeOut parameter is set to 500 milliseconds, there is a 1.5 second delay before the thread sending the alert is available to send another event. Malfunctioning event destinations could delay the amount of time it takes API Gateway to report events, or it could cause discarded events when the queue reaches its maximum level.

Specifies the time (in milliseconds) to wait before the SNMP trap times out because the server destination is not responding.

This value schedules a timer that resends an SNMP event that has not yet completed when it expires. You must set a timeout value that ensures that the trap is sent to the SNMP server within the time frame. This parameter does not abort an event that is in progress. Set this parameter higher than the default when sending traps with large payloads. The default value is 500.

This parameter works with pg.cs.snmpTarget.retries to determine the delay in resending SNMP traps to malfunctioning SNMP servers (that is, it retries *sendTimeOut).

This means that if the retries parameter is set to 3, and the sendTimeOut parameter is set to 500 milliseconds, there is a 1.5 second delay before the thread sending the alert is available to send another event. Malfunctioning event destinations could delay the amount of time it takes API Gateway to report events, or it could cause discarded events when the queue reaches its maximum level.

Specifies the time interval (in seconds) after which an HTTP connection attempt times out.

The default value is 30 seconds.

This is a global property that applies to the endpoints of all APIs. If you prefer to specify a connection timeout for the endpoints of an API individually, set the HTTP Connection Timeout parameter in the API's Routing Protocols processing step, which would then take precedence over pg.endpoint.connectionTimeout.

The precedence of the Connection Timeout configuration is as follows:

Specifies the time interval (in seconds) after which a socket read attempt times out. Default value: 30 seconds.

This is a global property that applies to all APIs. If you prefer to specify a read timeout for APIs individually, set the Read Timeout field in the API's's Routing Protocols processing step, which would then take precedence over pg.endpoint.readTimeout.

The precedence of the Read Timeout configuration is as follows:

Specifies API Gateway's behavior of endpoints in a load-balanced routing scenario.

Possible values:

Specifies whether to use a third-party SNMPv1 community-based connection.

The default value is false.

When this property is set to true, the Community name of 3rd Party SNMP destination configuration is expected as base64 encoded.

Specifies the maximum size (in bytes) for SNMP traps.

The default value is 65535.

Specifies the number of times to resend SNMP traps upon failure.

Default value is 1.

This parameter works with pg.snmp.communityTarget.sendTimeOut to determine the delay in re-sending SNMP traps to malfunctioning SNMP servers (that is, it retries *sendTimeOut).

This means that if the retries parameter is set to 3, and the sendTimeOut parameter is set to 500 milliseconds, there is a 1.5 second delay before the thread sending the alert is available to send another event. Malfunctioning event destinations could delay the amount of time it takes API Gateway to report events, or it could cause discarded events when the queue reaches its maximum level.

Specifies the time (in milliseconds) to wait before the SNMP trap times out because the server destination is not responding. This value schedules a timer that resends an SNMP event that has not yet completed when it expires. You must set a timeout value that ensures that the trap is sent to the SNMP server within the time frame. This parameter does not abort an event that is in progress. Set this parameter higher than the default when sending traps with large payloads.

The default value is 500.

This parameter works with pg.snmp.communityTarget.retries to determine the delay in re-sending SNMP traps to non-responsive SNMP servers (that is, it retries *sendTimeOut).

This means that if the retries parameter is set to 3, and the sendTimeOut parameter is set to 500 milliseconds, there is a 1.5 second delay before the thread sending the alert is available to send another event. Malfunctioning event destinations could delay the amount of time it takes API Gateway to report events, or it could cause discarded events when the queue reaches its maximum level.

Specifies the number of milliseconds before an inactive connection to the third-party SNMP server is closed. If set to 0, the socket remains open indefinitely.

Specifies the maximum size (in bytes) for SNMP traps.

The default value is 65535.

Specifies the number of times to resend SNMP traps upon failure.

The default value is 1.

This parameter works with pg.snmp.userTarget.sendTimeOut to determine the delay in re-sending SNMP traps to malfunctioning SNMP servers (that is, it retries *sendTimeOut).

This means that if the retries parameter is set to 3, and the sendTimeOut parameter is set to 500 milliseconds, there is a 1.5 second delay before the thread sending the alert is available to send another event. Malfunctioning event destinations could delay the amount of time it takes API Gateway to report events, or it could cause discarded events when the queue reaches its maximum level.

Specifies the time (in milliseconds) to wait before the SNMP trap times out because the server destination is not responding. This value schedules a timer that resends an SNMP event that has not yet completed when it expires. You must set a timeout value that ensures that the trap is sent to the SNMP server within the time frame. This parameter does not abort an event that is in progress. Set this parameter higher than the default when sending traps with large payloads.

The default value is 500.

This parameter works with pg.snmp.userTarget.retries to determine the delay in resending SNMP traps to malfunctioning SNMP servers (that is, it retries *sendTimeOut).

This means that if the retries parameter is set to 3, and the sendTimeOut parameter is set to 500 milliseconds, there is a 1.5 second delay before the thread sending the alert is available to send another event. Malfunctioning event destinations could delay the amount of time it takes API Gateway to report events, or it could cause discarded events when the queue reaches its maximum level.

Specifies the maximum allowed number of threads to publish the performance metrics data to CentraSite.

The default value is 2.

Specifies the connection and read timeout, in milliseconds, for publishing performance metrics to CentraSite.

The default value is 5000.

Specifies whether the lost intervals from the recovered quota should be added.

Specifies the number of seconds that elapses before the quota survival processor task runs.

Specifies whether the port configuration synchronization across API Gateway cluster nodes is enabled or disabled.

Possible values:

Specifies whether the native service status has to be sent to the client when an Outbound Authentication policy action is applied to the API.

Possible values:

Specifies the status code to be included in the response when a request to the native service times out.

Possible values:

Specifies whether the audit logs have to be saved along with payload.

Possible values:

Specifies whether the URI that is present in a request must be decoded before sending it to the native service.

Possible values:

Specifies that default content type to be included in the GET and DELETE methods, if the content type is missing in request.

Possible values:

Specifies whether API Gateway must perform a strict matching of the resource path from runtime invocation with the API definition of resource paths.

Possible values:

Specifies the maximum size for transform pool that consists XSLT transformers. To reduce performance impacts, you can reuse the transformers from the pool instead of creating them for every request.

Specifies the index format used when sending data from API Gateway to a configured Elasticsearch destination.

The default value is true.

Elasticsearch verison 7.2 supports data with dedicated index for each of the event types. So, API Gateway sends data in different indexes for different event types if the value of this property is set to true. The event type is concatenated with the Elasticsearch destination index name. That is, the index name will be in the following format: {IndexName}_{EventType}. For example, database_transactionalevents; where default is the index name and transactional events in the event type.

If the value is set to false, the type name is not concatenated with the index name. In this case, the index created for each event is sub-indexed under a main index when data is sent to configured Elasticsearch destination. The value of this setting must be set to false, if the version of the destination Elasticsearch is 5.x or earlier.