Parallels REST API

Get

Retrieve the Reporting Settings.

get

/api/Reporting

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/Reporting'

200

401

{
  "enabled": true,
  "deltaCpu": 1,
  "deltaMemory": 1,
  "enableCustomReports": true,
  "folderName": "text",
  "port": 1,
  "server": "text",
  "useCredentials": true,
  "username": "text",
  "trackServerTime": 1,
  "trackServers": true,
  "trackSessionTime": 1,
  "trackSessions": true,
  "trackLogonDetails": true,
  "trackLogonDetailsTime": 1,
  "trackUserExperience": true,
  "trackUserExperienceTime": 1,
  "deltaUXEvaluator": 1,
  "deltaLatency": 1,
  "deltaBandwidth": 1
}

Success

Update

Modify the Reporting Settings.

put

/api/Reporting

Body

enabledboolean | nullable

<para type="description">Enable or disable RAS Reporting functionality.</para>

deltaCpuinteger · int32 | nullable

<para type="description">Minimum CPU change required to track the counter.</para>

deltaMemoryinteger · int32 | nullable

<para type="description">Minimum Memory change required to track the counter.</para>

enableCustomReportsboolean | nullable

<para type="description">Enable or disable custom report.</para>

folderNamestring | nullable

<para type="description">Custom report folder name.</para>

portinteger · int32 | nullable

<para type="description">Port used by the service which receives data from the RAS Connection Broker. The default port is 30008.</para>

serverstring | nullable

<para type="description">The FQDN or IP address of the server where RAS Reporting is installed.</para>

useCredentialsboolean | nullable

<para type="description">Enable or disable Username/Password credentials to connect to the Server hosting RAS Reporting.</para>

usernamestring | nullable

<para type="description">Username to connect to the Server hosting RAS Reporting (if UseCredentials is enabled).</para>

passwordstring | nullable

<para type="description">Password to connect to the Server hosting RAS Reporting (if UseCredentials is enabled).</para>

trackServerTimeinteger · int32 | nullable

<para type="description">How long the server counters information (such as CPU, Memory and number of sessions) is kept (in seconds).</para>

trackServersboolean | nullable

<para type="description">Enable or disable Server counters information tracking.</para>

trackSessionTimeinteger · int32 | nullable

<para type="description">How long information regarding the sessions opened is kept (in seconds).</para>

trackSessionsboolean | nullable

<para type="description">Enable or disable Sessions information tracking.</para>

trackLogonDetailsboolean | nullable

<para type="description">Enable or disable Logon information tracking.</para>

trackLogonDetailsTimeinteger · int32 | nullable

<para type="description">How long information regarding the logon is kept (in seconds).</para>

trackUserExperienceboolean | nullable

<para type="description">Enable or disable User experience tracking.</para>

trackUserExperienceTimeinteger · int32 | nullable

<para type="description">How long information regarding the user experience is kept (in seconds).</para>

deltaUXEvaluatorinteger · int32 | nullable

<para type="description">Track UX Evaluator when change is more than user input.</para>

deltaLatencyinteger · int32 | nullable

<para type="description">Track Delta latency when change is more than user input.</para>

deltaBandwidthinteger · int32 | nullable

<para type="description">Track Delta bandwidth when change is more than user input.</para>