Parallels REST API

Upload Installer

Upload an FSLogix Installer file to the FSLogix Profile Containers Feature Site Settings.

put

/api/FSLogix/ProfileContainer/UploadInstaller

Query parameters

siteIdinteger · int32

The Site ID for which to modify the FSLogix Profile Containers Feature settings.

Body

InstallerFilestring · binary

Upload File

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/FSLogix/ProfileContainer/UploadInstaller' \
  --header 'Content-Type: multipart/form-data' \
  --form 'InstallerFile=text'

204

401

404

No body

No Content

Get

Retrieve the FSLogix Profile Containers Feature Site Settings.

get

/api/FSLogix/ProfileContainer

Query parameters

siteIdinteger · int32

The Site ID for which to retrieve the FSLogix Profile Containers Feature settings.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/FSLogix/ProfileContainer'

200

401

404

{
  "siteId": 1,
  "installType": [
    "0 = Manually",
    "1 = Online",
    "2 = NetworkDrive",
    "3 = UploadInstall"
  ],
  "installOnlineURL": "text",
  "networkDrivePath": "text",
  "installerFileName": "text",
  "replicate": true
}

Success

Update

Update the FSLogix Profile Containers Feature Site Settings.

put

/api/FSLogix/ProfileContainer

Query parameters

siteIdinteger · int32

The Site ID for which to modify the FSLogix Profile Containers Feature settings.

Body

installTypestring · enum

<para type="synopsis">Install Type values.</para> <para type="description"></para>

Options: 0 = Manually,1 = Online,2 = NetworkDrive,3 = UploadInstall

installOnlineURLstring | nullable

<para type="description">Specifies the 'Install Online URL Online'.</para>

networkDrivePathstring | nullable

<para type="description">Specifies the 'Network Drive Path'.</para>

installerFilePathstring | nullable

<para type="description">Specifies the 'Installer File Path'.</para>

replicateboolean | nullable

<para type="description">Enable or disable replication of settings to other sites.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/FSLogix/ProfileContainer' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "installType": [
      "0 = Manually",
      "1 = Online",
      "2 = NetworkDrive",
      "3 = UploadInstall"
    ],
    "installOnlineURL": "text",
    "networkDrivePath": "text",
    "installerFilePath": "text",
    "replicate": true
  }'

204

401

404

No body

No Content