WindowsService | Parallels REST API

List

Retrieve Default Windows Service Custom

GET/api/VDIDefaultSettings/Optimization/WindowsService

Query parameters

Response

Success

Body

typeDetailsType (enum)

Details Type

0 = Predefined,1 = Custom

serviceNamenullable string

Windows Services Name

displayNamenullable string

Windows Services Display Name

aliasesnullable string

Windows Service Aliases

Request

const response = await fetch('/api/VDIDefaultSettings/Optimization/WindowsService', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "type": [
      "0 = Predefined",
      "1 = Custom"
    ],
    "serviceName": "text",
    "displayName": "text",
    "aliases": "text"
  }
]

Add

Adds a default Windows Service Custom to optimization.

POST/api/VDIDefaultSettings/Optimization/WindowsService

Query parameters

Body

Windows Services Settings.

aliasesnullable string

Windows Services Alias

displayNamenullable string

Windows Services Diplay Name

serviceNamenullable string

Windows Service Name

Response

Created

Request

const response = await fetch('/api/VDIDefaultSettings/Optimization/WindowsService', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Delete

Removes Default Windows Service Custom From Optimization.

DELETE/api/VDIDefaultSettings/Optimization/WindowsService

Query parameters

Body

Windows Service Custom Settings

serviceNamenullable string

Windows Service Name

Response

No Content

Request

const response = await fetch('/api/VDIDefaultSettings/Optimization/WindowsService', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}