Connection Settings

List

Retrieve a list of all remote session settings.

GET/api/ConnectionSettings

Query parameters

Response

200401404

Success

Body

application/json; api-version=1.0

fipsModeFIPSModeSett (enum)

FIPS Mode Setting

0 = Disabled,1 = Allowed,2 = Enforced

remoteIdleSessionTimeoutinteger (int32)

The session idle timeout (in seconds).

logoffIdleSessionTimeoutinteger (int32)

The client logoff timeout (in seconds).

cachedSessionTimeoutinteger (int32)

The cached session timeout (in seconds).

replicateSettingsboolean

Whether to replicate settings to other sites.

siteIdinteger (int32)

ID of the Site.

Request

JavaScriptCurlPython

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

Response

200401404

{
  "fipsMode": [
    "0 = Disabled",
    "1 = Allowed",
    "2 = Enforced"
  ],
  "replicateSettings": false
}

Update

Update settings of a remote session

PUT/api/ConnectionSettings

Query parameters

Body

application/json; api-version=1.0

Remote session settings

remoteIdleSessionTimeoutnullable integer (int32)

Set the session idle timeout (in seconds).

logoffIdleSessionTimeoutnullable integer (int32)

Set the client logoff timeout (in seconds).

cachedSessionTimeoutnullable integer (int32)

Set the cached session timeout (in seconds).

fipsModeFIPSModeSett (enum)

FIPS Mode Setting

0 = Disabled,1 = Allowed,2 = Enforced

replicateSettingsnullable boolean

Whether to replicate settings to other sites.

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/ConnectionSettings', {
    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",
  "detail": "text",
  "instance": "text"
}