System

Get

get

Retrieve the System settings

Query parameters

siteIdinteger · int32Optional

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/SystemSettings

HTTPcURLJavaScriptPython

GET /api/SystemSettings HTTP/1.1
Host: 
Accept: */*

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

Update

put

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

Query parameters

siteIdinteger · int32Optional

Site ID

Body

application/json; api-version=1.0

cepEnabledboolean | nullableOptional

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

resetIdleSessionAfterMinsinteger · int32 | nullableOptional

Reset RAS Console Idle session after (minutes).

checkForUpdateOnLaunchboolean | nullableOptional

Whether Check for update is enabled on launch.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

/api/SystemSettings

HTTPcURLJavaScriptPython

PUT /api/SystemSettings HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 79

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

No content