getHttpServerSettings

Description: get the settings of the HTTP server.

Request example:

{
    "method" : "getHttpServerSettings",
    "requestId" : "1"
}

Response example:

{
    "settings": [
        {
            "name": "httpServerPort",
            "value": 5002,
            "httpServerRestartNeededForApplying": true,
            "isPendingToBeApplied": true,
            "pendingValue": 7777
        },
        {
            "name": "httpServerConnectionsLimit",
            "value": 10000,
            "httpServerRestartNeededForApplying": true,
            "isPendingToBeApplied": false
        },
        {
            "name": "httpServerMaxPostFileSizeInBytes",
            "value": -1,
            "httpServerRestartNeededForApplying": false
        }
    ],
    "method": "",
    "requestId" : "1",
    "result": true
}

Parameter description:

name — the name of a configuration. The following settings are available:
- httpServerPort — Port for the HTTP server. Restarting the HTTP server is required for the changes to take effect.
- httpServerConnectionsLimit — Maximum number of concurrently processed connections. Restarting the HTTP server is required for the changes to take effect.
- httpServerMaxPostFileSizeInBytes — Maximum file value in bytes for the POST method. It applies immediately; restarting the HTTP server is not required.
value — the value of a setting
httpServerRestartNeededForApplying — Flag showing whether it is necessary to restart the HTTP server in order for the setting to take effect. It can be true and false.
isPendingToBeApplied — The parameter is available only for settings that are applied after restarting the HTTP server and shows the state of a setting, namely waiting for restarting the HTTP server to apply the value.
pendingValue — The parameter is available only for settings that are applied after restarting the HTTP server when a setting has been changed and is waiting for the restart of the HTTP server and shows the value to be applied.
requestId - a unique request identifier. You can find more details about it here.

See also: