Windows Device Groups

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

200

Success

application/json; api-version=1.0

/// /// Windows device group

idinteger · int32Optional

ID of the object.

adminCreatestring · nullableOptional

User who created the object.

adminLastModstring · nullableOptional

User who last modified the object.

timeCreatestring · date-timeOptional

Time when the object was created.

timeLastModstring · date-timeOptional

Time when the object was last modified.

siteIdinteger · int32Optional

The ID of the Site from which to retrieve the Windows device group.

namestring · nullableOptional

Windows device group name

descriptionstring · nullableOptional

Description of the Windows device group

disableRemovableDrivesbooleanOptional

Whether Removeable drives are disabled or not.

disablePrintScreenbooleanOptional

Whether Print Screens are disabled or not.

replaceDesktopbooleanOptional

Whether the Replace Desktop option is enabled or not.

kioskModebooleanOptional

Whether the Kiosk Mode option is enabled or not.

useClientAsDesktopbooleanOptional

Whether the Use Client As Desktop option is enabled or not.

enableFirewallbooleanOptional

Whether the Firewall option is enabled or not.

requestAuthorizationbooleanOptional

Whether the Request Authorization option is enabled or not.

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/WinDeviceGroup

HTTPcURLJavaScriptPython

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

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2026-03-10T16:35:11.845Z",
    "timeLastMod": "2026-03-10T16:35:11.845Z",
    "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

application/json; api-version=1.0

Create a new Windows Device Group

namestring · min: 1 · max: 255 · nullableRequired

Name of the new Windows Device Group.

descriptionstring · min: 1 · max: 255 · nullableOptional

Description of the new Windows Device Group.

Responses

201

Created

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

post

/api/WinDeviceGroup

HTTPcURLJavaScriptPython

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

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

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2026-03-10T16:35:11.845Z",
  "timeLastMod": "2026-03-10T16:35:11.845Z",
  "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
}

Get

get

Retrieve a specific Windows device group by ID.

Path parameters

idinteger · int32Required

Windows device group Id

Responses

200

Success

application/json; api-version=1.0

/// /// Windows device group

idinteger · int32Optional

ID of the object.

adminCreatestring · nullableOptional

User who created the object.

adminLastModstring · nullableOptional

User who last modified the object.

timeCreatestring · date-timeOptional

Time when the object was created.

timeLastModstring · date-timeOptional

Time when the object was last modified.

siteIdinteger · int32Optional

The ID of the Site from which to retrieve the Windows device group.

namestring · nullableOptional

Windows device group name

descriptionstring · nullableOptional

Description of the Windows device group

disableRemovableDrivesbooleanOptional

Whether Removeable drives are disabled or not.

disablePrintScreenbooleanOptional

Whether Print Screens are disabled or not.

replaceDesktopbooleanOptional

Whether the Replace Desktop option is enabled or not.

kioskModebooleanOptional

Whether the Kiosk Mode option is enabled or not.

useClientAsDesktopbooleanOptional

Whether the Use Client As Desktop option is enabled or not.

enableFirewallbooleanOptional

Whether the Firewall option is enabled or not.

requestAuthorizationbooleanOptional

Whether the Request Authorization option is enabled or not.

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/WinDeviceGroup/{id}

HTTPcURLJavaScriptPython

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

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2026-03-10T16:35:11.845Z",
  "timeLastMod": "2026-03-10T16:35:11.845Z",
  "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

application/json; api-version=1.0

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

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

/api/WinDeviceGroup/{id}

HTTPcURLJavaScriptPython

PUT /api/WinDeviceGroup/{id} HTTP/1.1
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

Delete

delete

Delete a Windows device group by ID.

Path parameters

idinteger · int32Required

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

/api/WinDeviceGroup/{id}

HTTPcURLJavaScriptPython

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

No content