Reporting | Parallels REST API

Parallels REST API

Products Support Partners Documentation

Get

get

Retrieve the Reporting Settings.

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

put

Modify the Reporting Settings.

Body

Update RAS Reporting settings

enabledboolean | nullableoptional

Enable or disable RAS Reporting functionality.

deltaCpuinteger · int32 | nullableoptional

Minimum CPU change required to track the counter.

deltaMemoryinteger · int32 | nullableoptional

Minimum Memory change required to track the counter.

enableCustomReportsboolean | nullableoptional

Enable or disable custom report.

folderNamestring | nullableoptional

Custom report folder name.

portinteger · int32 | nullableoptional

Port used by the service which receives data from the RAS Connection Broker. The default port is 30008.

serverstring | nullableoptional

The FQDN or IP address of the server where RAS Reporting is installed.

useCredentialsboolean | nullableoptional

Enable or disable Username/Password credentials to connect to the Server hosting RAS Reporting.

usernamestring | nullableoptional

Username to connect to the Server hosting RAS Reporting (if UseCredentials is enabled).

passwordstring | nullableoptional

Password to connect to the Server hosting RAS Reporting (if UseCredentials is enabled).

trackServerTimeinteger · int32 | nullableoptional

How long the server counters information (such as CPU, Memory and number of sessions) is kept (in seconds).

trackServersboolean | nullableoptional

Enable or disable Server counters information tracking.

trackSessionTimeinteger · int32 | nullableoptional

How long information regarding the sessions opened is kept (in seconds).

trackSessionsboolean | nullableoptional

Enable or disable Sessions information tracking.

trackLogonDetailsboolean | nullableoptional

Enable or disable Logon information tracking.

trackLogonDetailsTimeinteger · int32 | nullableoptional

How long information regarding the logon is kept (in seconds).

trackUserExperienceboolean | nullableoptional

Enable or disable User experience tracking.

trackUserExperienceTimeinteger · int32 | nullableoptional

How long information regarding the user experience is kept (in seconds).

deltaUXEvaluatorinteger · int32 | nullableoptional

Track UX Evaluator when change is more than user input.

deltaLatencyinteger · int32 | nullableoptional

Track Delta latency when change is more than user input.

deltaBandwidthinteger · int32 | nullableoptional

Track Delta bandwidth when change is more than user input.