Parallels REST API

Get

Retrieves the FSLogix General Settings of a Site Defaults object.

get

/api/AVD/DefaultSettings/MultiSession/FSLogix/General

Query parameters

siteIdinteger · int32

The SiteId of a Site Defaults object for which to retrieve the FSLogix General Settings (optional).

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/AVD/DefaultSettings/MultiSession/FSLogix/General'

200

401

404

{
  "appServices": {
    "useCleanupInvalidSessions": true,
    "cleanupInvalidSessions": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useRoamRecycleBin": true,
    "roamRecycleBin": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useVHDCompactDisk": true,
    "vhdCompactDisk": [
      "0 = Disable",
      "1 = Enable"
    ]
  },
  "cloudCacheGeneral": {
    "useCacheDirectory": true,
    "cacheDirectory": "text",
    "useWriteCacheDirectory": true,
    "writeCacheDirectory": "text",
    "useProxyDirectory": true,
    "proxyDirectory": "text",
    "useSilenceACLWarning": true,
    "silenceACLWarning": [
      "0 = Disable",
      "1 = Enable"
    ]
  },
  "logging": {
    "logEnabled": [
      "0 = Disable",
      "1 = Specific",
      "2 = All"
    ],
    "logLevel": [
      "0 = Debug",
      "1 = Information",
      "2 = Warning",
      "3 = Error"
    ],
    "logFileKeepingPeriod": 1,
    "logDirectory": "text",
    "robocopyLogPath": "text",
    "logSpecificComponents": [
      "1 = ProfileConfigTool",
      "2 = IEPlugin",
      "4 = RuleEditor",
      "8 = JavaRuleEditor",
      "16 = FSLogixAgentService",
      "32 = Profile",
      "64 = JavaLauncher",
      "128 = OfficeContainer",
      "256 = RuleCompilation",
      "512 = FontVisibility",
      "1024 = Network",
      "2048 = PrinterVisibility",
      "4096 = ADSComputerGroup",
      "8192 = DriverInterface",
      "16384 = WindowsSearchRoaming",
      "32768 = WindowsSearchPlugin",
      "65536 = ProcessStartMonitor"
    ]
  }
}

Success

Update

Update the FSLogix General Settings of a Site Defaults object.

put

/api/AVD/DefaultSettings/MultiSession/FSLogix/General

Query parameters

siteIdinteger · int32

The Site ID of an object for which to modify the FSLogix General Settings (optional).

Body

useCleanupInvalidSessionsboolean | nullable

<para type="description">Specifies if the 'Cleanup invalid sessions' option is enabled or disabled.</para>

cleanupInvalidSessionsstring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useRoamRecycleBinboolean | nullable

<para type="description">Specifies if the 'Roam recycle bin' option is enabled or disabled.</para>

roamRecycleBinstring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useVHDCompactDiskboolean | nullable

<para type="description">Specifies if the 'VHD compact disk' option is enabled or disabled.</para>

vhdCompactDiskstring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useCacheDirectoryboolean | nullable

<para type="description">Specifies if the 'Cache directory' option is enabled or disabled.</para>

cacheDirectorystring | nullable

<para type="description">Specifies the 'Cache directory'.</para>

useWriteCacheDirectoryboolean | nullable

<para type="description">Specifies if the 'Write cache directory' option is enabled or disabled.</para>

writeCacheDirectorystring | nullable

<para type="description">Specifies the 'Write cache directory'.</para>

useProxyDirectoryboolean | nullable

<para type="description">Specifies if the 'Proxy directory' option is enabled or disabled.</para>

proxyDirectorystring | nullable

<para type="description">Specifies the 'Proxy directory'.</para>

useSilenceACLWarningboolean | nullable

<para type="description">Specifies if the 'Silence ACL warning' option is enabled or disabled.</para>

silenceACLWarningstring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

logEnabledstring · enum

<para type="synopsis">Log enabled values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Specific,2 = All

logLevelstring · enum

<para type="synopsis">FSLogix log level values.</para> <para type="description"></para>

Options: 0 = Debug,1 = Information,2 = Warning,3 = Error

logFileKeepingPeriodinteger · int32 | nullable

<para type="description">Specifies the 'Log keeping period in days'. Default: '2'.</para>

logDirectorystring | nullable

<para type="description">Specifies the 'Log directory'. Default: '%ProgramData%\FSLogix\Logs'.</para>

robocopyLogPathstring | nullable

<para type="description">Specifies the 'Robocopy log path'.</para>

logSpecificComponentsstring[Flag] · enum

<para type="synopsis">Log specific components values.</para> <para type="description"></para>

Options:

1 = ProfileConfigTool,2 = IEPlugin,4 = RuleEditor,8 = JavaRuleEditor,16 = FSLogixAgentService,32 = Profile,64 = JavaLauncher,128 = OfficeContainer,256 = RuleCompilation,512 = FontVisibility,1024 = Network,2048 = PrinterVisibility,4096 = ADSComputerGroup,8192 = DriverInterface,16384 = WindowsSearchRoaming,32768 = WindowsSearchPlugin,65536 = ProcessStartMonitor

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/AVD/DefaultSettings/MultiSession/FSLogix/General' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "useCleanupInvalidSessions": true,
    "cleanupInvalidSessions": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useRoamRecycleBin": true,
    "roamRecycleBin": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useVHDCompactDisk": true,
    "vhdCompactDisk": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useCacheDirectory": true,
    "cacheDirectory": "text",
    "useWriteCacheDirectory": true,
    "writeCacheDirectory": "text",
    "useProxyDirectory": true,
    "proxyDirectory": "text",
    "useSilenceACLWarning": true,
    "silenceACLWarning": [
      "0 = Disable",
      "1 = Enable"
    ],
    "logEnabled": [
      "0 = Disable",
      "1 = Specific",
      "2 = All"
    ],
    "logLevel": [
      "0 = Debug",
      "1 = Information",
      "2 = Warning",
      "3 = Error"
    ],
    "logFileKeepingPeriod": 1,
    "logDirectory": "text",
    "robocopyLogPath": "text",
    "logSpecificComponents": [
      "1 = ProfileConfigTool",
      "2 = IEPlugin",
      "4 = RuleEditor",
      "8 = JavaRuleEditor",
      "16 = FSLogixAgentService",
      "32 = Profile",
      "64 = JavaLauncher",
      "128 = OfficeContainer",
      "256 = RuleCompilation",
      "512 = FontVisibility",
      "1024 = Network",
      "2048 = PrinterVisibility",
      "4096 = ADSComputerGroup",
      "8192 = DriverInterface",
      "16384 = WindowsSearchRoaming",
      "32768 = WindowsSearchPlugin",
      "65536 = ProcessStartMonitor"
    ]
  }'

204

401

404

No body

No Content