> For the complete documentation index, see [llms.txt](https://docs.parallels.com/landing/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.parallels.com/landing/ras-rest-api-guide/api-reference/site-settings/windows-device-groups.md).

# Windows Device Groups

## List

> Retrieve a list of Windows device groups.

```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/WinDeviceGroup":{"get":{"tags":["2-Site settings//Windows Device Groups"],"summary":"List","description":"Retrieve a list of Windows device groups.","operationId":"686947ad-e9cd-4eec-b8d0-b030d529026d","parameters":[{"name":"siteId","in":"query","description":"Site ID for which to retrieve the Windows device group (optional).","schema":{"type":"integer","format":"int32"}},{"name":"Name","in":"query","description":"Filter the result by Windows device group name (optional).","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json; api-version=1.0":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WinDeviceGroup"}}}}},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"WinDeviceGroup":{"type":"object","properties":{"id":{"type":"integer","description":"<para type=\"description\">ID of the object.</para>","format":"int32"},"adminCreate":{"type":"string","description":"<para type=\"description\">User who created the object.</para>","nullable":true},"adminLastMod":{"type":"string","description":"<para type=\"description\">User who last modified the object.</para>","nullable":true},"timeCreate":{"type":"string","description":"<para type=\"description\">Time when the object was created.</para>","format":"date-time"},"timeLastMod":{"type":"string","description":"<para type=\"description\">Time when the object was last modified.</para>","format":"date-time"},"siteId":{"type":"integer","description":"<para type=\"description\">The ID of the Site from which to retrieve the Windows device group.</para>","format":"int32"},"name":{"type":"string","description":"<para type=\"description\">Windows device group name</para>","nullable":true},"description":{"type":"string","description":"<para type=\"description\">Description of the Windows device group</para>","nullable":true},"disableRemovableDrives":{"type":"boolean","description":"<para type=\"description\">Whether Removeable drives are disabled or not.</para>"},"disablePrintScreen":{"type":"boolean","description":"<para type=\"description\">Whether Print Screens are disabled or not.</para>"},"replaceDesktop":{"type":"boolean","description":"<para type=\"description\">Whether the Replace Desktop option is enabled or not.</para>"},"kioskMode":{"type":"boolean","description":"<para type=\"description\">Whether the Kiosk Mode option is enabled or not.</para>"},"useClientAsDesktop":{"type":"boolean","description":"<para type=\"description\">Whether the Use Client As Desktop option is enabled or not.</para>"},"enableFirewall":{"type":"boolean","description":"<para type=\"description\">Whether the Firewall option is enabled or not.</para>"},"inboundPorts":{"type":"array","items":{"$ref":"#/components/schemas/WinDeviceGroupInboundPort"},"description":"<para type=\"description\">The Inbound Ports.</para>","nullable":true},"requestAuthorization":{"type":"boolean","description":"<para type=\"description\">Whether the Request Authorization option is enabled or not.</para>"}},"additionalProperties":false,"description":"/// \r\n/// <para type=\"synopsis\">Windows device group</para><para type=\"description\"></para>"},"WinDeviceGroupInboundPort":{"type":"object","properties":{"port":{"type":"integer","description":"<para type=\"description\">Port number.</para>","format":"int32"},"protocol":{"$ref":"#/components/schemas/Protocol"},"profile":{"$ref":"#/components/schemas/Profile"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Windows device group - Inbound port</para>\r\n<para type=\"description\"></para>"},"Protocol":{"enum":[["0 = TCP","1 = UDP"]],"type":"string","description":"<para type=\"synopsis\">Connection Protocol type.</para>\r\n<para type=\"description\"></para>","format":"int32"},"Profile":{"enum":[["1 = Domain","2 = Private","4 = Public","2147483647 = All"]],"type":"string[Flag]","description":"<para type=\"synopsis\">Profile Setting.</para>\r\n<para type=\"description\"></para>","format":"int32"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

## Create

> Create a new Windows device group.

```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/WinDeviceGroup":{"post":{"tags":["2-Site settings//Windows Device Groups"],"summary":"Create","description":"Create a new Windows device group.","operationId":"49d5a983-6fb5-41f6-82ca-a3ec63e2a519","requestBody":{"description":"Windows device group settings","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/NewWinDeviceGroup"}}}},"responses":{"201":{"description":"Created","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/WinDeviceGroup"}}}},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"NewWinDeviceGroup":{"required":["name"],"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Name of the new Windows Device Group.</para>","nullable":true},"description":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Description of the new Windows Device Group.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Create a new Windows Device Group</para>\r\n<para type=\"description\"></para>"},"WinDeviceGroup":{"type":"object","properties":{"id":{"type":"integer","description":"<para type=\"description\">ID of the object.</para>","format":"int32"},"adminCreate":{"type":"string","description":"<para type=\"description\">User who created the object.</para>","nullable":true},"adminLastMod":{"type":"string","description":"<para type=\"description\">User who last modified the object.</para>","nullable":true},"timeCreate":{"type":"string","description":"<para type=\"description\">Time when the object was created.</para>","format":"date-time"},"timeLastMod":{"type":"string","description":"<para type=\"description\">Time when the object was last modified.</para>","format":"date-time"},"siteId":{"type":"integer","description":"<para type=\"description\">The ID of the Site from which to retrieve the Windows device group.</para>","format":"int32"},"name":{"type":"string","description":"<para type=\"description\">Windows device group name</para>","nullable":true},"description":{"type":"string","description":"<para type=\"description\">Description of the Windows device group</para>","nullable":true},"disableRemovableDrives":{"type":"boolean","description":"<para type=\"description\">Whether Removeable drives are disabled or not.</para>"},"disablePrintScreen":{"type":"boolean","description":"<para type=\"description\">Whether Print Screens are disabled or not.</para>"},"replaceDesktop":{"type":"boolean","description":"<para type=\"description\">Whether the Replace Desktop option is enabled or not.</para>"},"kioskMode":{"type":"boolean","description":"<para type=\"description\">Whether the Kiosk Mode option is enabled or not.</para>"},"useClientAsDesktop":{"type":"boolean","description":"<para type=\"description\">Whether the Use Client As Desktop option is enabled or not.</para>"},"enableFirewall":{"type":"boolean","description":"<para type=\"description\">Whether the Firewall option is enabled or not.</para>"},"inboundPorts":{"type":"array","items":{"$ref":"#/components/schemas/WinDeviceGroupInboundPort"},"description":"<para type=\"description\">The Inbound Ports.</para>","nullable":true},"requestAuthorization":{"type":"boolean","description":"<para type=\"description\">Whether the Request Authorization option is enabled or not.</para>"}},"additionalProperties":false,"description":"/// \r\n/// <para type=\"synopsis\">Windows device group</para><para type=\"description\"></para>"},"WinDeviceGroupInboundPort":{"type":"object","properties":{"port":{"type":"integer","description":"<para type=\"description\">Port number.</para>","format":"int32"},"protocol":{"$ref":"#/components/schemas/Protocol"},"profile":{"$ref":"#/components/schemas/Profile"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Windows device group - Inbound port</para>\r\n<para type=\"description\"></para>"},"Protocol":{"enum":[["0 = TCP","1 = UDP"]],"type":"string","description":"<para type=\"synopsis\">Connection Protocol type.</para>\r\n<para type=\"description\"></para>","format":"int32"},"Profile":{"enum":[["1 = Domain","2 = Private","4 = Public","2147483647 = All"]],"type":"string[Flag]","description":"<para type=\"synopsis\">Profile Setting.</para>\r\n<para type=\"description\"></para>","format":"int32"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

## Get

> Retrieve a specific Windows device group by ID.

```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/WinDeviceGroup/{id}":{"get":{"tags":["2-Site settings//Windows Device Groups"],"summary":"Get","description":"Retrieve a specific Windows device group by ID.","operationId":"678d40f1-2981-4d99-82c2-f801381f7e3a","parameters":[{"name":"id","in":"path","description":"Windows device group Id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/WinDeviceGroup"}}}},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"WinDeviceGroup":{"type":"object","properties":{"id":{"type":"integer","description":"<para type=\"description\">ID of the object.</para>","format":"int32"},"adminCreate":{"type":"string","description":"<para type=\"description\">User who created the object.</para>","nullable":true},"adminLastMod":{"type":"string","description":"<para type=\"description\">User who last modified the object.</para>","nullable":true},"timeCreate":{"type":"string","description":"<para type=\"description\">Time when the object was created.</para>","format":"date-time"},"timeLastMod":{"type":"string","description":"<para type=\"description\">Time when the object was last modified.</para>","format":"date-time"},"siteId":{"type":"integer","description":"<para type=\"description\">The ID of the Site from which to retrieve the Windows device group.</para>","format":"int32"},"name":{"type":"string","description":"<para type=\"description\">Windows device group name</para>","nullable":true},"description":{"type":"string","description":"<para type=\"description\">Description of the Windows device group</para>","nullable":true},"disableRemovableDrives":{"type":"boolean","description":"<para type=\"description\">Whether Removeable drives are disabled or not.</para>"},"disablePrintScreen":{"type":"boolean","description":"<para type=\"description\">Whether Print Screens are disabled or not.</para>"},"replaceDesktop":{"type":"boolean","description":"<para type=\"description\">Whether the Replace Desktop option is enabled or not.</para>"},"kioskMode":{"type":"boolean","description":"<para type=\"description\">Whether the Kiosk Mode option is enabled or not.</para>"},"useClientAsDesktop":{"type":"boolean","description":"<para type=\"description\">Whether the Use Client As Desktop option is enabled or not.</para>"},"enableFirewall":{"type":"boolean","description":"<para type=\"description\">Whether the Firewall option is enabled or not.</para>"},"inboundPorts":{"type":"array","items":{"$ref":"#/components/schemas/WinDeviceGroupInboundPort"},"description":"<para type=\"description\">The Inbound Ports.</para>","nullable":true},"requestAuthorization":{"type":"boolean","description":"<para type=\"description\">Whether the Request Authorization option is enabled or not.</para>"}},"additionalProperties":false,"description":"/// \r\n/// <para type=\"synopsis\">Windows device group</para><para type=\"description\"></para>"},"WinDeviceGroupInboundPort":{"type":"object","properties":{"port":{"type":"integer","description":"<para type=\"description\">Port number.</para>","format":"int32"},"protocol":{"$ref":"#/components/schemas/Protocol"},"profile":{"$ref":"#/components/schemas/Profile"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Windows device group - Inbound port</para>\r\n<para type=\"description\"></para>"},"Protocol":{"enum":[["0 = TCP","1 = UDP"]],"type":"string","description":"<para type=\"synopsis\">Connection Protocol type.</para>\r\n<para type=\"description\"></para>","format":"int32"},"Profile":{"enum":[["1 = Domain","2 = Private","4 = Public","2147483647 = All"]],"type":"string[Flag]","description":"<para type=\"synopsis\">Profile Setting.</para>\r\n<para type=\"description\"></para>","format":"int32"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

## Update

> Update Windows device group settings.

```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/WinDeviceGroup/{id}":{"put":{"tags":["2-Site settings//Windows Device Groups"],"summary":"Update","description":"Update Windows device group settings.","operationId":"a1aab59c-5a64-413a-97d9-e06bf8c294a4","parameters":[{"name":"id","in":"path","description":"Windows device group ID.","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Windows device group settings.","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/SetWinDeviceGroup"}}}},"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"SetWinDeviceGroup":{"type":"object","properties":{"displayName":{"type":"string","description":"<para type=\"description\">Modify the description of the Windows Device Group.</para>","nullable":true},"description":{"type":"string","description":"<para type=\"description\">Modify the description of the Windows Device Group.</para>","nullable":true},"enabled":{"type":"boolean","description":"<para type=\"description\">Enable or disable the Windows Device Group.</para>","nullable":true},"disableRemovableDrives":{"type":"boolean","description":"<para type=\"description\">Enable or disable Removeable Drives.</para>","nullable":true},"disablePrintScreen":{"type":"boolean","description":"<para type=\"description\">Enable or disable Print Screens.</para>","nullable":true},"replaceDesktop":{"type":"boolean","description":"<para type=\"description\">Enable or disable the Replace Desktop option.</para>","nullable":true},"kioskMode":{"type":"boolean","description":"<para type=\"description\">Enable or disable Kiosk Mode.</para>","nullable":true},"useClientAsDesktop":{"type":"boolean","description":"<para type=\"description\">Enable or disable the Client As Desktop option.</para>","nullable":true},"adminModePassword":{"type":"string","description":"<para type=\"description\">The Admin Mode Passoword.</para>","nullable":true},"enableFirewall":{"type":"boolean","description":"<para type=\"description\">Enable or disable Firewall option.</para>","nullable":true},"requestAuthorization":{"type":"boolean","description":"<para type=\"description\">Enable or disable the Request Authorization option.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Modify a Windows Device Group</para>\r\n<para type=\"description\"></para>"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

## Delete

> Delete a Windows device group by ID.

```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/WinDeviceGroup/{id}":{"delete":{"tags":["2-Site settings//Windows Device Groups"],"summary":"Delete","description":"Delete a Windows device group by ID.","operationId":"584b1186-7e84-4ce7-aa36-8e5ed4a0080e","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.parallels.com/landing/ras-rest-api-guide/api-reference/site-settings/windows-device-groups.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.