Parallels REST API

Get

get

Retrieve FSLogix Profile Container Folder Exclusion List of a session server with the specified ID.

Path parameters

idinteger · int32required

The ID of a session server for which to retrieve the FSLogix Profile Container settings.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/FolderExclusion'

200

401

404

[
  "text"
]

Success

Add

post

Add a folder to the Folder Exclusion List of the FSLogix Profile Container settings.

Path parameters

idinteger · int32required

The ID of a session server for which to modify the FSLogix Profile Container settings.

Body

folderstring | nullablerequired

<para type="description">Specifies the 'Folder' path to add to the Include/Exclude Folder List.</para>

excludeFolderCopystring[Flag] · enum

<para type="synopsis">Exclude Folder Copy values.</para> <para type="description"></para>

Options: 0 = None,1 = CopyBase,2 = CopyBack

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/FolderExclusion' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "folder": "text",
    "excludeFolderCopy": [
      "0 = None",
      "1 = CopyBase",
      "2 = CopyBack"
    ]
  }'

201

401

404

409

No body

Created

Update

put

Modify an item in the folder exclusion list of the FSLogix Profile Container settings.

Path parameters

idinteger · int32required

The ID of a session server for which to modify the FSLogix Profile Container settings.

Body

folderstring | nullablerequired

<para type="description">Specifies the 'Folder' path to modify within Exclude Folder List.</para>

excludeFolderCopystring[Flag] · enumrequired

<para type="synopsis">Exclude Folder Copy values.</para> <para type="description"></para>

Options: 0 = None,1 = CopyBase,2 = CopyBack

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/FolderExclusion' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "folder": "text",
    "excludeFolderCopy": [
      "0 = None",
      "1 = CopyBase",
      "2 = CopyBack"
    ]
  }'

201

401

404

409

No body

Created

Delete

delete

Remove a folder from the Folder Exclusion List of the FSLogix Profile Container settings.

Path parameters

idinteger · int32required

The ID of a session server for which to modify the FSLogix Profile Container settings.

Body

folderstring | nullablerequired

<para type="description">Specifies the 'Folder' path to remove to the Include/Exclude Folder List.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/FolderExclusion' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "folder": "text"
  }'

204

401

404

No body

No Content