Parallels REST API

Get

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

get

/api/AVD/HostPool/{id}/FSLogix/ProfileContainer/UserExclusion

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/AVD/HostPool/{id}/FSLogix/ProfileContainer/UserExclusion'

200

401

404

[
  {
    "account": "text",
    "type": [
      "1 = User",
      "2 = Group",
      "3 = ForeignSecurityPrincipal",
      "4 = Computer"
    ],
    "sid": "text"
  }
]

Success

Add

Add a user to the User Exclusion List of the FSLogix Profile Container settings.

post

/api/AVD/HostPool/{id}/FSLogix/ProfileContainer/UserExclusion

Path parameters

idinteger · int32required

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

Body

accountstring | nullable

<para type="description">The name of the user/group account to add to the FSLogix Container.</para>

sidstring | nullable

<para type="description">The SID of the user/group account to add to the FSLogix Container.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/AVD/HostPool/{id}/FSLogix/ProfileContainer/UserExclusion' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "account": "text",
    "sid": "text"
  }'

201

401

404

409

No body

Created

Delete

Remove a user from the User Exclusion List of the FSLogix Profile Container settings.

delete

/api/AVD/HostPool/{id}/FSLogix/ProfileContainer/UserExclusion

Path parameters

idinteger · int32required

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

Body

accountstring | nullable

<para type="description">The name of the user/group account to remove from the FSLogix Container.</para>

sidstring | nullable

<para type="description">The SID of the user/group account to remove from the FSLogix Container.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/AVD/HostPool/{id}/FSLogix/ProfileContainer/UserExclusion' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "account": "text",
    "sid": "text"
  }'

204

401

404

No body

No Content