System

PreviousScanning NextTenant Broker

Last updated 10 months ago

Was this helpful?

Get

Retrieve the System settings

GET/api/SystemSettings

Query parameters

Response

Success

Body

cepEnabledboolean

Whether CEP Is Enabled or not

resetIdleSessionAfterMinsinteger (int32)

The Time to reset idle session

Request

const response = await fetch('/api/SystemSettings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "cepEnabled": true,
  "resetIdleSessionAfterMins": 1
}

Update

Modify System Settings. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.

PUT/api/SystemSettings

Query parameters

Body

System Settings

cepEnablednullable boolean

Customer Experience Program: Enable (True) or disable (False).

httpProxyModeenum

HTTP Proxy Mode

0 = NoProxy,1 = ManualSettings

resetIdleSessionAfterMinsnullable integer (int32)

Reset RAS Console Idle session after (minutes).

Response

No Content

Request

const response = await fetch('/api/SystemSettings', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "httpProxyMode": [
        "0 = NoProxy",
        "1 = ManualSettings"
      ]
    }),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "status": 1,
  "detail": "text",
  "instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}