System

Get

Retrieve the System settings

GET/api/SystemSettings

Query parameters

Response

200401404

Success

Body

application/json; api-version=1.0

cepEnabledboolean

Whether CEP Is Enabled or not

resetIdleSessionAfterMinsinteger (int32)

The Time to reset idle session

Request

JavaScriptCurlPython

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

Response

200401404

{
  "cepEnabled": false,
  "resetIdleSessionAfterMins": 0
}

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

application/json; api-version=1.0

System Settings

cepEnablednullable boolean

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

httpProxyModeProxyMode (enum)

HTTP Proxy Mode

0 = NoProxy,1 = ManualSettings

resetIdleSessionAfterMinsnullable integer (int32)

Reset RAS Console Idle session after (minutes).

Response

204401404

No Content

Request

JavaScriptCurlPython

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

Response

401404

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}