External DocumentationTo learn more, visit the Automox documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Organization ID | The Organization ID you wish to list from. The organization will be assumed based on the API key, if not specified. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Exception | Filter based on the exception property to exclude the device from reports. Device is still monitored when excluded from reports and statistics. Format: exception=1. |
| Filters | Filter on compatible devices. |
| Group ID | Filter based on membership to a specific Server Group ID. |
| Limit | A limit on the number of results to be returned, between 1 and 500, with a default of 500. Use with page parameter.See About Automox API - Pagination. |
| Managed | Filter based on device’s Managed status. Unmanaged indicates no linked policies. Format: managed=0. |
| Page | The page of results you wish to be returned with page numbers starting at 0.See About Automox API - Pagination. |
| Patch Status | Filter based on presence of ANY available patches that aren’t already installed. Value must be ‘missing’ Format: patchStatus=missing. |
| Pending | Filter based on status of pending patches. Format: pending=1. |
| Policy ID | Filter based on association to a given Policy ID. Format: policyId=12345. |
| PowerShell Version | Shows version of PowerShell running on the device, if applicable. |
| Sort Columns | The column you want to sort by. |
| Sort Dir | The sort direction, ascending or descending. |
Example Output
[
{
"id": 4214184,
"agent_version": "<string>",
"commands": [],
"compatibility_checks": {
"low_diskspace": false
},
"compliant": true,
"connected": false,
"create_time": "2025-05-11T09:52:50+0000",
"custom_name": "<string>",
"deleted": false,
"detail": {},
"display_name": "<string>",
"exception": false,
"instance_id": "<string>",
"ip_addrs": [
"<string>"
],
"ip_addrs_private": [
"<string>",
"<string>"
],
"is_compatible": true,
"is_delayed_by_notification": false,
"is_delayed_by_user": false,
"last_disconnect_time": "2025-05-11T09:52:50+0000",
"last_logged_in_user": "<string>",
"last_process_time": "2025-05-11T09:52:50+0000",
"last_refresh_time": "2025-05-11T09:52:50+0000",
"last_scan_failed": false,
"last_update_time": null,
"mdm": null,
"name": "<string>",
"notes": "<string>",
"needs_attention": false,
"needs_reboot": false,
"next_patch_time": null,
"notification_count": 2,
"organization_id": 188198,
"organizational_unit": "<string>",
"os_family": "<string>",
"os_name": "<string>",
"os_version": "<string>",
"os_version_id": 32791,
"patch_deferral_count": 0,
"patches": 2,
"pending": true,
"pending_patches": 1,
"policy_status": [
{
"id": 3356506096,
"organization_id": 78704,
"policy_id": 150586,
"server_id": 7762789,
"policy_name": "<string>",
"policy_type_name": "<string>",
"status": 1,
"result": "<string>",
"create_time": "2025-05-11T09:52:50+0000",
"will_reboot": false,
"pending_count": 0,
"next_remediation": null
},
{
"id": 11127478296,
"organization_id": 85568,
"policy_id": 367390,
"server_id": 8154658,
"policy_name": "<string>",
"policy_type_name": "<string>",
"status": 1,
"result": "<string>",
"create_time": "2025-05-11T09:52:50+0000",
"will_reboot": false,
"pending_count": 1,
"next_remediation": null
}
],
"reboot_deferral_count": 2,
"reboot_is_delayed_by_notification": false,
"reboot_is_delayed_by_user": false,
"reboot_notification_count": 2,
"refresh_interval": 419,
"serial_number": "<string>",
"server_group_id": 81479,
"server_policies": [],
"status": {
"device_status": "<string>",
"agent_status": "<string>",
"policy_status": "<string>",
"policy_statuses": [
{
"id": 217749,
"compliant": false
},
{
"id": 363600,
"compliant": true
}
]
},
"tags": [],
"timezone": "<string>",
"total_count": 78,
"uptime": "2025-05-11T09:52:50+0000",
"uuid": "<string>"
},
{
"id": 7341091,
"agent_version": "<string>",
"commands": [],
"compatibility_checks": {
"low_diskspace": false
},
"compliant": true,
"connected": true,
"create_time": "2025-05-11T09:52:50+0000",
"custom_name": "<string>",
"deleted": false,
"detail": {},
"display_name": "<string>",
"exception": false,
"instance_id": "<string>",
"ip_addrs": [
"<string>"
],
"ip_addrs_private": [
"<string>",
"<string>"
],
"is_compatible": true,
"is_delayed_by_notification": false,
"is_delayed_by_user": false,
"last_disconnect_time": null,
"last_logged_in_user": "<string>",
"last_process_time": "2025-05-11T09:52:50+0000",
"last_refresh_time": "2025-05-11T09:52:50+0000",
"last_scan_failed": false,
"last_update_time": null,
"mdm": null,
"name": "<string>",
"notes": "<string>",
"needs_attention": false,
"needs_reboot": false,
"next_patch_time": null,
"notification_count": 1,
"organization_id": 78297,
"organizational_unit": "<string>",
"os_family": "<string>",
"os_name": "<string>",
"os_version": "<string>",
"os_version_id": 27251,
"patch_deferral_count": 2,
"patches": 14,
"pending": false,
"pending_patches": 1,
"policy_status": [],
"reboot_deferral_count": 2,
"reboot_is_delayed_by_notification": false,
"reboot_is_delayed_by_user": false,
"reboot_notification_count": 1,
"refresh_interval": 349,
"serial_number": "<string>",
"server_group_id": 206038,
"server_policies": [],
"status": {
"device_status": "<string>",
"agent_status": "<string>",
"policy_status": "<string>",
"policy_statuses": []
},
"tags": [],
"timezone": "<string>",
"total_count": 43,
"uptime": "2025-05-11T09:52:50+0000",
"uuid": "<string>"
}
]
Workflow Library Example
List Devices with Automox and Send Results Via Email