| Line 1: | Line 1: | ||
= Service Client API= | = Service Client API= | ||
__TOC__ | __TOC__ | ||
| + | <section begin="service-client-api.accepted-web-content-origins"/> | ||
====service-client-api.accepted-web-content-origins==== | ====service-client-api.accepted-web-content-origins==== | ||
* Default Value: ''An empty string'' | * Default Value: ''An empty string'' | ||
| Line 6: | Line 7: | ||
* Changes take effect: When the session is started or restarted. | * Changes take effect: When the session is started or restarted. | ||
* Description: Specifies the list of granted origins and allowed APIs that are used in the web extension views. This option cannot be overridden and must be set in the '''WWEWS Cluster''' application. | * Description: Specifies the list of granted origins and allowed APIs that are used in the web extension views. This option cannot be overridden and must be set in the '''WWEWS Cluster''' application. | ||
| − | + | <section end="service-client-api.accepted-web-content-origins"/> | |
| + | <section begin="service-client-api.rate-limit"/> | ||
====service-client-api.rate-limit==== | ====service-client-api.rate-limit==== | ||
* Default Value: | * Default Value: | ||
| Line 12: | Line 14: | ||
* Changes take effect: When the session is started or restarted. | * Changes take effect: When the session is started or restarted. | ||
* Description: Specifies the limit for the maximum number of requests per minute on the Service Client API. This option cannot be overridden and must be set in the '''WWEWS Cluster''' application. | * Description: Specifies the limit for the maximum number of requests per minute on the Service Client API. This option cannot be overridden and must be set in the '''WWEWS Cluster''' application. | ||
| − | + | <section end="service-client-api.rate-limit"/> | |
| + | <section begin="service-client-api.rate-limit-quarantine-delay"/> | ||
====service-client-api.rate-limit-quarantine-delay==== | ====service-client-api.rate-limit-quarantine-delay==== | ||
* Default Value: | * Default Value: | ||
| Line 18: | Line 21: | ||
* Changes take effect: When the session is started or restarted. | * Changes take effect: When the session is started or restarted. | ||
* Description: Specifies the quarantine delay, in seconds, once the rate limit is reached. The requests are not ignored anymore after this delay. This option cannot be overridden and must be set in the '''WWEWS Cluster''' application. | * Description: Specifies the quarantine delay, in seconds, once the rate limit is reached. The requests are not ignored anymore after this delay. This option cannot be overridden and must be set in the '''WWEWS Cluster''' application. | ||
| − | + | <section end="service-client-api.rate-limit-quarantine-delay"/> | |
[[Category:V:HTCC:8.5.2DRAFT]] | [[Category:V:HTCC:8.5.2DRAFT]] | ||
Revision as of 16:28, May 27, 2015
Service Client API
Contents
service-client-api.accepted-web-content-origins
- Default Value: An empty string
- Valid Values: A comma-separated list of URLs or '*' — for example: 'http://my-web-server-1,http://my-web-server-2' or '*'.
- Changes take effect: When the session is started or restarted.
- Description: Specifies the list of granted origins and allowed APIs that are used in the web extension views. This option cannot be overridden and must be set in the WWEWS Cluster application.
service-client-api.rate-limit
- Default Value:
- Valid Values: An integer value greater than or equal to 0. Specify 0 for an unlimited rate.
- Changes take effect: When the session is started or restarted.
- Description: Specifies the limit for the maximum number of requests per minute on the Service Client API. This option cannot be overridden and must be set in the WWEWS Cluster application.
service-client-api.rate-limit-quarantine-delay
- Default Value:
- Valid Values: An integer value greater than or equal to 0. Specify 0 for infinite quarantine delay.
- Changes take effect: When the session is started or restarted.
- Description: Specifies the quarantine delay, in seconds, once the rate limit is reached. The requests are not ignored anymore after this delay. This option cannot be overridden and must be set in the WWEWS Cluster application.
Comments or questions about this documentation? Contact us for support!