Windows Device Groups | Parallels REST API

Parallels REST API

SupportDocumentation

Get

get

Retrieve a specific Windows device group by ID.

Path parameters

idinteger · int32Required

Windows device group Id

Responses

application/json; api-version=1.0

objectOptional

/// /// Windows device group

application/json; api-version=1.0

get

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

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-04-18T19:33:46.827Z",
  "timeLastMod": "2025-04-18T19:33:46.827Z",
  "siteId": 1,
  "name": "text",
  "description": "text",
  "disableRemovableDrives": true,
  "disablePrintScreen": true,
  "replaceDesktop": true,
  "kioskMode": true,
  "useClientAsDesktop": true,
  "enableFirewall": true,
  "inboundPorts": [
    {
      "port": 1,
      "protocol": [
        "0 = TCP",
        "1 = UDP"
      ],
      "profile": [
        "1 = Domain",
        "2 = Private",
        "4 = Public",
        "2147483647 = All"
      ]
    }
  ],
  "requestAuthorization": true
}

Delete

delete

Delete a Windows device group by ID.

Path parameters

idinteger · int32Required

Responses

application/json; api-version=1.0

delete

DELETE /api/WinDeviceGroup/{id} HTTP/1.1
Host: 
Accept: */*

No content

List

get

Retrieve a list of Windows device groups.

Query parameters

siteIdinteger · int32Optional

Site ID for which to retrieve the Windows device group (optional).

NamestringOptional

Filter the result by Windows device group name (optional).

Responses

application/json; api-version=1.0

object[]Optional

/// /// Windows device group

application/json; api-version=1.0

get

GET /api/WinDeviceGroup HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-04-18T19:33:46.827Z",
    "timeLastMod": "2025-04-18T19:33:46.827Z",
    "siteId": 1,
    "name": "text",
    "description": "text",
    "disableRemovableDrives": true,
    "disablePrintScreen": true,
    "replaceDesktop": true,
    "kioskMode": true,
    "useClientAsDesktop": true,
    "enableFirewall": true,
    "inboundPorts": [
      {
        "port": 1,
        "protocol": [
          "0 = TCP",
          "1 = UDP"
        ],
        "profile": [
          "1 = Domain",
          "2 = Private",
          "4 = Public",
          "2147483647 = All"
        ]
      }
    ],
    "requestAuthorization": true
  }
]

Create

post

Create a new Windows device group.

Body

Create a new Windows Device Group

namestring | nullableRequired

Name of the new Windows Device Group.

descriptionstring | nullableOptional

Description of the new Windows Device Group.

Responses

application/json; api-version=1.0

objectOptional

/// /// Windows device group

application/json; api-version=1.0

post

POST /api/WinDeviceGroup HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 36

{
  "name": "text",
  "description": "text"
}

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-04-18T19:33:46.827Z",
  "timeLastMod": "2025-04-18T19:33:46.827Z",
  "siteId": 1,
  "name": "text",
  "description": "text",
  "disableRemovableDrives": true,
  "disablePrintScreen": true,
  "replaceDesktop": true,
  "kioskMode": true,
  "useClientAsDesktop": true,
  "enableFirewall": true,
  "inboundPorts": [
    {
      "port": 1,
      "protocol": [
        "0 = TCP",
        "1 = UDP"
      ],
      "profile": [
        "1 = Domain",
        "2 = Private",
        "4 = Public",
        "2147483647 = All"
      ]
    }
  ],
  "requestAuthorization": true
}

Update

put

Update Windows device group settings.

Path parameters

idinteger · int32Required

Windows device group ID.

Body

Modify a Windows Device Group

displayNamestring | nullableOptional

Modify the description of the Windows Device Group.

descriptionstring | nullableOptional

Modify the description of the Windows Device Group.

enabledboolean | nullableOptional

Enable or disable the Windows Device Group.

disableRemovableDrivesboolean | nullableOptional

Enable or disable Removeable Drives.

disablePrintScreenboolean | nullableOptional

Enable or disable Print Screens.

replaceDesktopboolean | nullableOptional

Enable or disable the Replace Desktop option.

kioskModeboolean | nullableOptional

Enable or disable Kiosk Mode.

useClientAsDesktopboolean | nullableOptional

Enable or disable the Client As Desktop option.

adminModePasswordstring | nullableOptional

The Admin Mode Passoword.

enableFirewallboolean | nullableOptional

Enable or disable Firewall option.

requestAuthorizationboolean | nullableOptional

Enable or disable the Request Authorization option.

Responses

application/json; api-version=1.0

put

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

{
  "displayName": "text",
  "description": "text",
  "enabled": true,
  "disableRemovableDrives": true,
  "disablePrintScreen": true,
  "replaceDesktop": true,
  "kioskMode": true,
  "useClientAsDesktop": true,
  "adminModePassword": "text",
  "enableFirewall": true,
  "requestAuthorization": true
}

No content