WAwatchguard

Retrieves a list of devices.

Retrieves a list of devices, and additional information, such as the device IP address and operating system. The response to this request is limited to 3,000 records.

get/api/v1/accounts/{accountId}/devices

Request

Path parameters

accountIdstring required

Your WatchGuard Cloud account ID.

Query parameters

topinteger

Specifies the number of objects to retrieve (there is a maximum supported by the server).

skipinteger

Bypasses the specified number of objects in the results returned.

searchstring

Returns only objects that include the specified text string.

countboolean

Indicates whether to return a counter that shows the total number of objects in the total_items response parameter.

orderbystring

Specifies how to order results. You can order by any parameter in the response and sort results in ascending or descending order.

configboolean

Indicates whether the security configuration name and ID are returned. The default value is true.

Response

OK

total_itemsinteger nullable

Optionally, if Count parameter is provided, we return here the total number of items

Example response

{
  "data": {
    "device_id": "287324d8-194f-4f5a-a7ad-e2480d5ad1b2",
    "account_id": "cd6c6dd6-r97o-453d-ld8o-a5976dc0596c",
    "site_id": "8b7205bc-60e0-45a0-9956-b17b6a8673f6",
    "site_name": "AD360",
    "host_name": "WIN_SERVER_6",
    "type": 3,
    "description": "Marketing server",
    "domain": "WORKGROUP",
    "platform_id": 1,
    "ip_address": "192.0.2.1",
    "operating_system": "Microsoft Windows 10",
    "isolation_state": 1,
    "encryption": 6,
    "reinstall_agent_requested": true,
    "reboot_requested": true,
    "agent_version": "1.17.00.0000",
    "last_connection": "2020-09-22T11:00:00Z",
    "security_configuration_id": "287324d8-194f-4f5a-a7ad-e2480d5ad1b2",
    "custom_group_folder_path": "All\\ServersFolderName\\GroupName1",
    "active_directory_canonical_name": "ROOTDOMAIN.local\\Computers\\Servers\\Division\\DEVICE_5"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.