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
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
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
No content
Retrieve a Windows device group's Inbound ports by ID.
Windows device group Id
Success
Unauthorized
Not Found
Add an Inbound port to a Windows device group by ID.
Windows device group Id
Add an Inbound Port to a Windows Device Group
The Port to add to the windows device group.
Connection Protocol type.
Profile Setting.
Created
Unauthorized
Not Found
No content
Remove an Inbound port from a Windows device group by ID.
Windows device group Id
Remove an Inbound Port from a Windows Device Group
The Port of the Windows Device Group to remove.
Connection Protocol type.
Profile Setting.
No Content
Unauthorized
Not Found
No content
GET /api/WinDeviceGroup HTTP/1.1
Host:
Accept: */*
[
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-09T02:38:09.984Z",
"timeLastMod": "2025-12-09T02:38:09.984Z",
"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
}
]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-12-09T02:38:09.984Z",
"timeLastMod": "2025-12-09T02:38:09.984Z",
"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 /api/WinDeviceGroup/{id} HTTP/1.1
Host:
Accept: */*
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-12-09T02:38:09.984Z",
"timeLastMod": "2025-12-09T02:38:09.984Z",
"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
}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
}DELETE /api/WinDeviceGroup/{id} HTTP/1.1
Host:
Accept: */*
GET /api/WinDeviceGroup/{id}/InboundPort HTTP/1.1
Host:
Accept: */*
[
{
"port": 1,
"protocol": [
"0 = TCP",
"1 = UDP"
],
"profile": [
"1 = Domain",
"2 = Private",
"4 = Public",
"2147483647 = All"
]
}
]POST /api/WinDeviceGroup/{id}/InboundPort HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 114
{
"port": 1,
"protocol": [
"0 = TCP",
"1 = UDP"
],
"profile": [
"1 = Domain",
"2 = Private",
"4 = Public",
"2147483647 = All"
]
}DELETE /api/WinDeviceGroup/{id}/InboundPort HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 114
{
"port": 1,
"protocol": [
"0 = TCP",
"1 = UDP"
],
"profile": [
"1 = Domain",
"2 = Private",
"4 = Public",
"2147483647 = All"
]
}