Settings
Retrieve the Web Admin settings. A local administrator on the Web Server or a RAS Root administrator can call this command.
Success
RAS Web Administration Service settings
Specifies the Allowed Hosts
Unauthorized
Not Found
GET /api/WebService/settings HTTP/1.1
Accept: */*
{
"allowedHosts": "text",
"kestrel": {
"endPoints": {
"httpsDefaultCert": {
"url": "text",
"certificate": {
"path": "text",
"encryptedPassword": "text"
}
}
}
},
"webAdminService": {
"webConsole": {
"enable": true,
"basePath": "text",
"pollingInterval": 1
},
"rest": {
"enable": true
},
"rasServer": {
"licenseServer": "text",
"secondaryServers": [
"text"
]
},
"session": {
"expire": 1,
"disconnectDelay": 1
}
},
"logging": {
"webAdmin": {
"logLevel": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
},
"routes": [
{
"downstreamPathTemplate": "text",
"downstreamScheme": "text",
"downstreamHostAndPorts": [
{
"host": "text",
"port": 1
}
],
"upstreamPathTemplate": "text"
}
],
"rateLimits": {
"global": {
"window": 1,
"autoReplenishment": true,
"permitLimit": 1,
"queueProcessingOrder": [
"0 = OldestFirst",
"1 = NewestFirst"
],
"queueLimit": 1
},
"logon": {
"window": 1,
"autoReplenishment": true,
"permitLimit": 1,
"queueProcessingOrder": [
"0 = OldestFirst",
"1 = NewestFirst"
],
"queueLimit": 1
}
}
}Modify the Web Admin settings. A local administrator on the Web Server or a RAS Root administrator can call this command.
Update RAS Web Administration Service settings
Specifies the Allowed Hosts.
Specifies the HTTPS URL.
Specifies whether to enable/disable Web Console.
Specifies the Web Console Base Path. The RAS Web Administration Server Service needs to be manually restarted for the BasePath change to be effective.
Specifies the Web Console Polling Interval (in seconds).
Specifies whether to enable/disable REST.
Specifies the RAS Licensing Server.
Specifies the RAS Secondary Servers.
Specifies the Session Expiry time in minutes.
Specifies the Session Disconnect Delay in seconds.
Specifies the Microsoft Log Level for the RAS Web Administration Service. Accepted values: Trace, Debug, Information, Warning, Error, Critical, None.
Sets the time window (in seconds) for global rate limiting. Default: 10 seconds. Only 50 requests are allowed per window by default. When the limit is reached, transactions are not allowed until the current window expires and a new window begins
Automatically resets the global rate limit counters at the end of each window (default is true).
Sets the maximum number of global requests allowed in each rate limit window. Default: 50 requests per 10 seconds. When the limit is reached, transactions are not allowed until the current window expires and a new window begins
Controls the behavior when not enough resources can be leased.
Specifies the maximum number of global requests that can be queued when the rate limit is exceeded.
Sets the time window (in seconds) for logon rate limiting. Default: 300 seconds. Only 4 logon requests are allowed per window by default. When the limit is reached, transactions are not allowed until the current window expires and a new window begins
Automatically resets the specific rate limit counters at the end of each window (default is true).
Sets the maximum number of logon requests allowed in each rate limit window. Default: 4 requests per 300 seconds. When the limit is reached, transactions are not allowed until the current window expires and a new window begins
Controls the behavior when not enough resources can be leased.
Specifies the maximum number of specific requests that can be queued when the rate limit is exceeded.
No Content
No content
Unauthorized
Not Found
PUT /api/WebService/settings HTTP/1.1
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 581
{
"allowedHosts": "text",
"httpsUrl": "text",
"enableWebConsole": true,
"webConsoleBasePath": "text",
"webConsolePollingInterval": 1,
"enableREST": true,
"rasLicensingServer": "text",
"rasSecondaryServers": [
"text"
],
"sessionExpire": 1,
"sessionDisconnectDelay": 1,
"defaultLogLevel": "text",
"globalWindow": 1,
"globalAutoReplenishment": true,
"globalPermitLimit": 1,
"globalQueueProcessingOrder": [
"0 = OldestFirst",
"1 = NewestFirst"
],
"globalQueueLimit": 1,
"loginWindow": 1,
"loginAutoReplenishment": true,
"loginPermitLimit": 1,
"loginQueueProcessingOrder": [
"0 = OldestFirst",
"1 = NewestFirst"
],
"loginQueueLimit": 1
}No content
Last updated