Optimization | Parallels REST API

Parallels REST API

Products Support Partners Documentation

Get

get

Retrieve Image Optimization Settings

Path parameters

idinteger · int32Required

Retrieve the Image Optimization by id

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/RDS/Host/{id}/Optimization HTTP/1.1
Host: 
Accept: */*

{
  "enableOptimization": true,
  "optimizationType": [
    "0 = Automatic",
    "1 = Manual"
  ],
  "windowsDefenderATP": {
    "winDefATPTurnOffOn": [
      "0 = TurnOffWindowsDefenderATP",
      "1 = TurnOnWindowsDefenderATP"
    ],
    "disableRealTimeProtection": true,
    "excludeFolders": [
      "text"
    ],
    "excludeProcesses": [
      "text"
    ],
    "excludeExtension": [
      "text"
    ]
  },
  "windowsComponents": {
    "windowsComponentsList": [
      {
        "type": [
          "0 = Predefined",
          "1 = Custom"
        ],
        "componentName": "text",
        "displayName": "text",
        "aliases": "text"
      }
    ]
  },
  "windowsDefenderATPEnabled": true,
  "windowsComponentsEnabled": true,
  "windowsServicesEnabled": true,
  "windowsScheduledTasksEnabled": true,
  "windowsAdvancedOptionsEnabled": true,
  "networkPerformanceEnabled": true,
  "registryEnabled": true,
  "visualEffectsEnabled": true,
  "diskCleanupEnabled": true,
  "customScriptEnabled": true,
  "windowsServices": {
    "windowsServicesList": [
      {
        "type": [
          "0 = Predefined",
          "1 = Custom"
        ],
        "serviceName": "text",
        "displayName": "text",
        "aliases": "text"
      }
    ]
  },
  "windowsAdvancedOptions": {
    "partialStartLayoutContent": "text",
    "hibernate": true,
    "teleCollection": true,
    "systemRestore": true,
    "additionalErrorReport": true,
    "tiles": true,
    "cortana": true,
    "microsoftConsumerExperience": true,
    "windowsTips": true,
    "commonProgramGroups": true,
    "partialStartMenu": true
  },
  "networkPerformance": {
    "dirCacheMax": 1,
    "dormantFileLimit": 1,
    "fileNotFoundCache": 1,
    "fileInfoCache": 1,
    "fileInfoCacheEnable": true,
    "directoryCacheEnable": true,
    "fileNotFoundCacheEnable": true,
    "dormantFileLimitEnable": true,
    "disableTCP": true,
    "disableIPv6CompEnable": true,
    "disableIPv6ToIPv4": true,
    "disableIsaTap": true
  },
  "customScript": {
    "arguments": "text",
    "command": "text",
    "initDir": "text",
    "user": "text"
  },
  "diskCleanup": {
    "cleanupWinSxSFolder": true,
    "cleanupSystemFiles": true,
    "cleanupTemporaryFileLogs": true,
    "removeOneDrive": true,
    "deleteUserProfiles": true
  },
  "visualEffects": {
    "visualEffectsTypes": [
      "0 = LetWindowsChooseWhatsBest",
      "1 = AdjustForBestAppearance",
      "2 = AdjustForBestPerformance",
      "3 = Custom"
    ],
    "animateControlSelectElements": true,
    "animateWindowsWhenMinimizingMaximizing": true,
    "animateTaskbar": true,
    "enablePeek": true,
    "fadeSlideMenus": true,
    "fadeSlideToolTips": true,
    "fadeOutMenuItems": true,
    "saveTaskbarThumbnail": true,
    "showShadowUnderMouse": true,
    "shadowUnderWindows": true,
    "thumbnailsInsteadOfIcons": true,
    "showTranslucentSelection": true,
    "showWindowsContentWhilstDragging": true,
    "slideOpenComboBoxes": true,
    "smoothEdgesScreenFonts": true,
    "smoothScrollListBoxes": true,
    "dropShadowsIcon": true
  },
  "windowsScheduledTasks": {
    "windowsScheduledTasksList": [
      {
        "task": "text",
        "location": "text",
        "type": [
          "0 = Folder",
          "1 = Task"
        ]
      }
    ]
  },
  "registry": {
    "registryList": [
      {
        "id": 1,
        "action": [
          "0 = Add",
          "1 = Modify",
          "2 = Delete"
        ],
        "registryName": "text",
        "dwordValue": 1,
        "displayName": "text",
        "hiveType": [
          "0 = HKEY_CURRENT_CONFIG",
          "1 = HKEY_USERS",
          "2 = HKEY_LOCAL_MACHINE",
          "3 = HKEY_CLASSES_ROOT"
        ],
        "path": "text",
        "regType": [
          "0 = REG_SZ",
          "1 = REG_DWORD",
          "2 = REG_QWORD",
          "3 = REG_MULTI_SZ",
          "4 = REG_EXPAND_SZ"
        ],
        "stringValue": "text"
      }
    ]
  },
  "uwpApps": {
    "allExcept": [
      "text"
    ],
    "followingPkgs": [
      "text"
    ],
    "removeType": [
      "0 = AllExcept",
      "1 = FollowingPkgs"
    ]
  }
}

Update

put

Update the Image Optimization settings with the specified ID.

Path parameters

idinteger · int32Required

The ID for which to modify the Image Optimization.

Body

enableOptimizationboolean | nullableOptional

Whether Optimization is Enabled or not

optimizationTypestring · enumOptional

Optimization Type

Possible values:

windowsDefenderATPEnabledboolean | nullableOptional

Whether Windows Defender ATP is enabled or not

windowsComponentsEnabledboolean | nullableOptional

Whether Windows Components is enabled or not

windowsServicesEnabledboolean | nullableOptional

Whether Windows Services is enabled or not

windowsScheduledTasksEnabledboolean | nullableOptional

Whether Windows Scheduled Task is enabled or not

windowsAdvancedOptionsEnabledboolean | nullableOptional

Whether Windows Advanced Options is enabled or not

networkPerformanceEnabledboolean | nullableOptional

Whether Network Performance is enabled or not

registryEnabledboolean | nullableOptional

Whether Registry is enabled or not

visualEffectsEnabledboolean | nullableOptional

Whether Visual Effects is enabled or not

diskCleanupEnabledboolean | nullableOptional

Whether Disk Cleanup is enabled or not

customScriptEnabledboolean | nullableOptional

Whether Custom Script is enabled or not

winDefATPTurnOffOnstring · enumOptional

Windows enable options

Possible values:

disableRealTimeProtectionboolean | nullableOptional

Disable Real Time Protection

excludeFoldersstring[] | nullableOptional

Exclude Folders List

excludeProcessesstring[] | nullableOptional

Exclude Processes

excludeExtensionstring[] | nullableOptional

Exclude Extensions

partialStartLayoutContentstring | nullableOptional

Partial Start menu layout

hibernateboolean | nullableOptional

Whether Hibernate is enabled or not

teleCollectionboolean | nullableOptional

Whether TeleCollection is enabled or not

systemRestoreboolean | nullableOptional

Whether System Restore is enabled or not

additionalErrorReportboolean | nullableOptional

Whether Additional Error Reporting is enabled or not

tilesboolean | nullableOptional

Whether Tiles is enabled or not

cortanaboolean | nullableOptional

Whether Cortana is enabled or not

microsoftConsumerExperienceboolean | nullableOptional

Whether Microsoft Consumer Experience is enabled or not

windowsTipsboolean | nullableOptional

Whether Windows Tips is enabled or not

commonProgramGroupsboolean | nullableOptional

Whether Common Program Groups is enabled or not

partialStartMenuboolean | nullableOptional

Whether Partial Start Menu is enabled or not

dirCacheMaxinteger · int32 | nullableOptional

Directory Cache Value

dormantFileLimitinteger · int32 | nullableOptional

Dormant File Limit Value

fileNotFoundCacheinteger · int32 | nullableOptional

File Not Found Cache Value

fileInfoCacheinteger · int32 | nullableOptional

File Info Cache Value

fileInfoCacheEnableboolean | nullableOptional

Whether File Info Cache is enabled or not

directoryCacheEnableboolean | nullableOptional

Whether Directory Cache is enabled or not

fileNotFoundCacheEnableboolean | nullableOptional

Whether File Not Found Cache is enabled or not

dormantFileLimitEnableboolean | nullableOptional

Whether Dormant File Limit is enabled or not

disableTCPboolean | nullableOptional

Whether Disable TCP is enabled or not

disableIPv6CompEnableboolean | nullableOptional

Whether Disable IPv6 Components is enabled or not

disableIPv6ToIPv4boolean | nullableOptional

Whether Disable IPv6 To IPv4 is enabled or not

disableIsaTapboolean | nullableOptional

Whether Disable IsaTap for IPv6 is enabled or not

argumentsstring | nullableOptional

Arguments

commandstring | nullableOptional

Command

initDirstring | nullableOptional

Initial Directory

userstring | nullableOptional

User

passwordstring | nullableOptional

Password

cleanupWinSxSFolderboolean | nullableOptional

Whether Clean up windows SxS Folder is enabled or not

cleanupSystemFilesboolean | nullableOptional

Whether Clean up system files is enabled or not

cleanupTemporaryFileLogsboolean | nullableOptional

Whether Clean up temporary file logs is enabled or not

removeOneDriveboolean | nullableOptional

Whether Remove One Drives is enabled or not

deleteUserProfilesboolean | nullableOptional

Whether Delete User Profiles is enabled or not

visualEffectsTypesstring · enumOptional

Visual Effects Type

Possible values:

animateControlSelectElementsboolean | nullableOptional

Whether Animate Control Select Elements is enabled or not

animateWindowsWhenMinimizingMaximizingboolean | nullableOptional

Whether Animate Windows When Minimizing Or Maximizing is enabled or not

animateTaskbarboolean | nullableOptional

Whether Animate Taskbar is enabled or not

enablePeekboolean | nullableOptional

Whether Peek is enabled or not

fadeSlideMenusboolean | nullableOptional

Whether Fade Slide Menus is enabled or not

fadeSlideToolTipsboolean | nullableOptional

Whether Fade Slide Tool Tips is enabled or not

fadeOutMenuItemsboolean | nullableOptional

Whether Fade Out Menu Items is enabled or not

saveTaskbarThumbnailboolean | nullableOptional

Whether Taskbar Thumbnail is enabled or not

showShadowUnderMouseboolean | nullableOptional

Whether Shadow Under Mouse is enabled or not

shadowUnderWindowsboolean | nullableOptional

Whether Shadow Under Windows is enabled or not

thumbnailsInsteadOfIconsboolean | nullableOptional

Whether Thumbnails instead of icons is enabled or not

showTranslucentSelectionboolean | nullableOptional

Whether Translucent Selection is enabled or not

showWindowsContentWhilstDraggingboolean | nullableOptional

Whether Windows Content Whilst Dragging is enabled or not

slideOpenComboBoxesboolean | nullableOptional

Whether Slide open combo boxes is enabled or not

smoothEdgesScreenFontsboolean | nullableOptional

Whether Smooth Edges Screen Fonts is enabled or not

smoothScrollListBoxesboolean | nullableOptional

Whether Smooth Scroll List Boxes is enabled or not

dropShadowsIconboolean | nullableOptional

Whether Drop Shadow Icon is enabled or not

forcebooleanOptional

Force Optimization.

Default: false

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

PUT /api/RDS/Host/{id}/Optimization HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 1975

{
  "enableOptimization": true,
  "optimizationType": [
    "0 = Automatic",
    "1 = Manual"
  ],
  "windowsDefenderATPEnabled": true,
  "windowsComponentsEnabled": true,
  "windowsServicesEnabled": true,
  "windowsScheduledTasksEnabled": true,
  "windowsAdvancedOptionsEnabled": true,
  "networkPerformanceEnabled": true,
  "registryEnabled": true,
  "visualEffectsEnabled": true,
  "diskCleanupEnabled": true,
  "customScriptEnabled": true,
  "winDefATPTurnOffOn": [
    "0 = TurnOffWindowsDefenderATP",
    "1 = TurnOnWindowsDefenderATP"
  ],
  "disableRealTimeProtection": true,
  "excludeFolders": [
    "text"
  ],
  "excludeProcesses": [
    "text"
  ],
  "excludeExtension": [
    "text"
  ],
  "partialStartLayoutContent": "text",
  "hibernate": true,
  "teleCollection": true,
  "systemRestore": true,
  "additionalErrorReport": true,
  "tiles": true,
  "cortana": true,
  "microsoftConsumerExperience": true,
  "windowsTips": true,
  "commonProgramGroups": true,
  "partialStartMenu": true,
  "dirCacheMax": 1,
  "dormantFileLimit": 1,
  "fileNotFoundCache": 1,
  "fileInfoCache": 1,
  "fileInfoCacheEnable": true,
  "directoryCacheEnable": true,
  "fileNotFoundCacheEnable": true,
  "dormantFileLimitEnable": true,
  "disableTCP": true,
  "disableIPv6CompEnable": true,
  "disableIPv6ToIPv4": true,
  "disableIsaTap": true,
  "arguments": "text",
  "command": "text",
  "initDir": "text",
  "user": "text",
  "password": "text",
  "cleanupWinSxSFolder": true,
  "cleanupSystemFiles": true,
  "cleanupTemporaryFileLogs": true,
  "removeOneDrive": true,
  "deleteUserProfiles": true,
  "visualEffectsTypes": [
    "0 = LetWindowsChooseWhatsBest",
    "1 = AdjustForBestAppearance",
    "2 = AdjustForBestPerformance",
    "3 = Custom"
  ],
  "animateControlSelectElements": true,
  "animateWindowsWhenMinimizingMaximizing": true,
  "animateTaskbar": true,
  "enablePeek": true,
  "fadeSlideMenus": true,
  "fadeSlideToolTips": true,
  "fadeOutMenuItems": true,
  "saveTaskbarThumbnail": true,
  "showShadowUnderMouse": true,
  "shadowUnderWindows": true,
  "thumbnailsInsteadOfIcons": true,
  "showTranslucentSelection": true,
  "showWindowsContentWhilstDragging": true,
  "slideOpenComboBoxes": true,
  "smoothEdgesScreenFonts": true,
  "smoothScrollListBoxes": true,
  "dropShadowsIcon": true,
  "force": false
}

No content