Connection Settings | Parallels REST API

Parallels REST API

Products Support Partners Documentation

List

get

Retrieve a list of all remote session settings.

Query parameters

SiteIdinteger · int32optional

Site ID for which to retrieve all remote session settings (optional).

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

200

401

404

{
  "fipsMode": [
    "0 = Disabled",
    "1 = Allowed",
    "2 = Enforced"
  ],
  "remoteIdleSessionTimeout": 1,
  "logoffIdleSessionTimeout": 1,
  "cachedSessionTimeout": 1,
  "replicateSettings": true,
  "siteId": 1
}

Success

Update

put

Update settings of a remote session

Query parameters

SiteIdinteger · int32optional

ID of the site for which the remote session settings will be updated

Body

Update user session settings

remoteIdleSessionTimeoutinteger · int32 | nullableoptional

Set the session idle timeout (in seconds).

logoffIdleSessionTimeoutinteger · int32 | nullableoptional

Set the client logoff timeout (in seconds).

cachedSessionTimeoutinteger · int32 | nullableoptional

Set the cached session timeout (in seconds).

fipsModestring · enumoptional

FIPS Mode Setting

Available options:

replicateSettingsboolean | nullableoptional

Whether to replicate settings to other sites.