Windows Device Groups

List

Retrieve a list of Windows device groups.

GET/api/WinDeviceGroup

Query parameters

Response

200401404

Success

Body

application/json; api-version=1.0

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

siteIdinteger (int32)

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

namenullable string

Windows device group name

descriptionnullable string

Description of the Windows device group

disableRemovableDrivesboolean

Whether Removeable drives are disabled or not.

disablePrintScreenboolean

Whether Print Screens are disabled or not.

replaceDesktopboolean

Whether the Replace Desktop option is enabled or not.

kioskModeboolean

Whether the Kiosk Mode option is enabled or not.

useClientAsDesktopboolean

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

enableFirewallboolean

Whether the Firewall option is enabled or not.

inboundPortsnullable array of WinDeviceGroupInboundPort (object)

The Inbound Ports.

requestAuthorizationboolean

Whether the Request Authorization option is enabled or not.

Request

JavaScriptCurlPython

const response = await fetch('/api/WinDeviceGroup', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

[
  {
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2024-11-07T07:32:58.351Z",
    "timeLastMod": "2024-11-07T07:32:58.351Z",
    "name": "text",
    "description": "text",
    "disableRemovableDrives": false,
    "disablePrintScreen": false,
    "replaceDesktop": false,
    "kioskMode": false,
    "useClientAsDesktop": false,
    "enableFirewall": false,
    "inboundPorts": [
      {
        "protocol": [
          "0 = TCP",
          "1 = UDP"
        ],
        "profile": [
          "1 = Domain",
          "2 = Private",
          "4 = Public",
          "2147483647 = All"
        ]
      }
    ],
    "requestAuthorization": false
  }
]

Create

Create a new Windows device group.

POST/api/WinDeviceGroup

Body

application/json; api-version=1.0

Windows device group settings

name*nullable string

Name of the new Windows Device Group.

descriptionnullable string

Description of the new Windows Device Group.

Response

201401404

Created

Body

application/json; api-version=1.0

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

siteIdinteger (int32)

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

namenullable string

Windows device group name

descriptionnullable string

Description of the Windows device group

disableRemovableDrivesboolean

Whether Removeable drives are disabled or not.

disablePrintScreenboolean

Whether Print Screens are disabled or not.

replaceDesktopboolean

Whether the Replace Desktop option is enabled or not.

kioskModeboolean

Whether the Kiosk Mode option is enabled or not.

useClientAsDesktopboolean

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

enableFirewallboolean

Whether the Firewall option is enabled or not.

inboundPortsnullable array of WinDeviceGroupInboundPort (object)

The Inbound Ports.

requestAuthorizationboolean

Whether the Request Authorization option is enabled or not.

Request

JavaScriptCurlPython

const response = await fetch('/api/WinDeviceGroup', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

201401404

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T07:32:58.351Z",
  "timeLastMod": "2024-11-07T07:32:58.351Z",
  "name": "text",
  "description": "text",
  "disableRemovableDrives": false,
  "disablePrintScreen": false,
  "replaceDesktop": false,
  "kioskMode": false,
  "useClientAsDesktop": false,
  "enableFirewall": false,
  "inboundPorts": [
    {
      "protocol": [
        "0 = TCP",
        "1 = UDP"
      ],
      "profile": [
        "1 = Domain",
        "2 = Private",
        "4 = Public",
        "2147483647 = All"
      ]
    }
  ],
  "requestAuthorization": false
}

Get

Retrieve a specific Windows device group by ID.

GET/api/WinDeviceGroup/{id}

Path parameters

id*integer (int32)

Windows device group Id

Response

200401404

Success

Body

application/json; api-version=1.0

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

siteIdinteger (int32)

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

namenullable string

Windows device group name

descriptionnullable string

Description of the Windows device group

disableRemovableDrivesboolean

Whether Removeable drives are disabled or not.

disablePrintScreenboolean

Whether Print Screens are disabled or not.

replaceDesktopboolean

Whether the Replace Desktop option is enabled or not.

kioskModeboolean

Whether the Kiosk Mode option is enabled or not.

useClientAsDesktopboolean

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

enableFirewallboolean

Whether the Firewall option is enabled or not.

inboundPortsnullable array of WinDeviceGroupInboundPort (object)

The Inbound Ports.

requestAuthorizationboolean

Whether the Request Authorization option is enabled or not.

Request

JavaScriptCurlPython

const response = await fetch('/api/WinDeviceGroup/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T07:32:58.351Z",
  "timeLastMod": "2024-11-07T07:32:58.351Z",
  "name": "text",
  "description": "text",
  "disableRemovableDrives": false,
  "disablePrintScreen": false,
  "replaceDesktop": false,
  "kioskMode": false,
  "useClientAsDesktop": false,
  "enableFirewall": false,
  "inboundPorts": [
    {
      "protocol": [
        "0 = TCP",
        "1 = UDP"
      ],
      "profile": [
        "1 = Domain",
        "2 = Private",
        "4 = Public",
        "2147483647 = All"
      ]
    }
  ],
  "requestAuthorization": false
}

Update

Update Windows device group settings.

PUT/api/WinDeviceGroup/{id}

Path parameters

id*integer (int32)

Windows device group ID.

Body

application/json; api-version=1.0

Windows device group settings.

displayNamenullable string

Modify the description of the Windows Device Group.

descriptionnullable string

Modify the description of the Windows Device Group.

enablednullable boolean

Enable or disable the Windows Device Group.

disableRemovableDrivesnullable boolean

Enable or disable Removeable Drives.

disablePrintScreennullable boolean

Enable or disable Print Screens.

replaceDesktopnullable boolean

Enable or disable the Replace Desktop option.

kioskModenullable boolean

Enable or disable Kiosk Mode.

useClientAsDesktopnullable boolean

Enable or disable the Client As Desktop option.

adminModePasswordnullable string

The Admin Mode Passoword.

enableFirewallnullable boolean

Enable or disable Firewall option.

requestAuthorizationnullable boolean

Enable or disable the Request Authorization option.

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/WinDeviceGroup/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Delete

Delete a Windows device group by ID.

DELETE/api/WinDeviceGroup/{id}

Path parameters

id*integer (int32)

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/WinDeviceGroup/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}