Windows Device Groups
Retrieve a list of Windows device groups.
Site ID for which to retrieve the Windows device group (optional).
Filter the result by Windows device group name (optional).
Success
Unauthorized
Not Found
GET /api/WinDeviceGroup HTTP/1.1
Host:
Accept: */*
[
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-08-23T04:48:53.457Z",
"timeLastMod": "2025-08-23T04:48:53.457Z",
"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 a new Windows device group.
Create a new Windows Device Group
Name of the new Windows Device Group.
Description of the new Windows Device Group.
Created
Unauthorized
Not Found
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-08-23T04:48:53.457Z",
"timeLastMod": "2025-08-23T04:48:53.457Z",
"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
}
Retrieve a specific Windows device group by ID.
Windows device group Id
Success
Unauthorized
Not Found
GET /api/WinDeviceGroup/{id} HTTP/1.1
Host:
Accept: */*
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-08-23T04:48:53.457Z",
"timeLastMod": "2025-08-23T04:48:53.457Z",
"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 Windows device group settings.
Windows device group ID.
Modify a Windows Device Group
Modify the description of the Windows Device Group.
Modify the description of the Windows Device Group.
Enable or disable the Windows Device Group.
Enable or disable Removeable Drives.
Enable or disable Print Screens.
Enable or disable the Replace Desktop option.
Enable or disable Kiosk Mode.
Enable or disable the Client As Desktop option.
The Admin Mode Passoword.
Enable or disable Firewall option.
Enable or disable the Request Authorization option.
No Content
Unauthorized
Not Found
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
Last updated
Was this helpful?