List a specific device

Retrieve a specific device (server object) for the authenticated user. See Using Global API Keys for more information on permission and scope requirements.

SecuritybearerAuth
Request
path Parameters
id
required
integer <int64>

Server ID for the specified device.

query Parameters
o
required
integer <int64>

Organization ID for the specified device.

PS_VERSION
integer <int64>

The version of PowerShell running on the device.

include_details
integer
Default: 0

Include device details in response. Format: include_details=1 See Automox API Documentation - Servers API - Fast by Default

Enum: 0 1
include_server_events
integer
Default: 0

Include server events (reboot_deferral_count and patch_deferral_count) in response. Format: include_server_events=1. See Automox API Documentation - Servers API - Fast by Default

Enum: 0 1
include_next_patch_time
integer
Default: 0

Include the next patch time in response. Format: include_next_patch_time=1. See Automox API Documentation - Servers API - Fast by Default

Enum: 0 1
exclude_policy_status
integer
Default: 0

Exclude the policy status in response. Format: exclude_policy_status=1. See Automox API Documentation - Servers API - Fast by Default

Enum: 0 1
Responses
200

successful operation

4XX

Invalid Request

default

Invalid Request

get/servers/{id}
Request samples 
$apiKey = 'your_automox_api_key'
$headers = @{ "Authorization" = "Bearer $apiKey" }
$url = "https://console.automox.com/api/servers/123456?o=0000"
$response = (Invoke-WebRequest -Method Get -Uri $url -Headers $headers).Content
Response samples
application/json
[
  • {
    • "id": 123456,
    • "agent_version": "1.45.48",
    • "commands": [ ],
    • "compatibility_checks": {
      • "low_diskspace": false,
      • "missing_wmi_integrity_check": false,
      • "missing_powershell": false
      },
    • "compliant": false,
    • "connected": false,
    • "create_time": "2024-12-19T17:42:48+0000",
    • "custom_name": "",
    • "deleted": false,
    • "detail": {
      • "VERSION": "LNVNB161216",
      • "VENDOR": "LENOVO",
      • "LAST_USER_LOGON": {
        • "SRC": "TEST",
        • "USER": "TEST\\john.doe",
        • "TIME": "12/25/2024 8:34:32 AM"
        },
      • "MODEL": "82R9",
      • "IPS": [
        • "192.168.8.135",
        • "bcb6:a517:7ac1:7c98:0b51:bcd3:1183:82a8",
        • "3399:59b4:f568:cada:76b6:ee0c:7a0e:7a75",
        • "41c0:fdce:d075:df45:35b2:c995:7caa:73b8",
        • "44ea:9f49:34e0:ddb6:ec1c:a368:b398:4f03",
        • "c5e8:d9d2:91fb:7a69:843b:d575:7dc4:2f44"
        ],
      • "WSUS_CONFIG": {
        • "WSUS_REACHABLE": "0",
        • "WSUS_MANAGED": "0",
        • "WSUS_SERVER": ""
        },
      • "MDM_PROFILE_INSTALLED": null,
      • "RAM": "17179869184",
      • "CPU": "AMD Ryzen 5 5500U with Radeon Graphics ",
      • "MDM_SERVER": null,
      • "FQDNS": [
        • "TEST.WORKGROUP"
        ],
      • "NICS": [
        • {
          • "CONNECTED": true,
          • "VENDOR": "MediaTek Wi-Fi 6 MT7921 Wireless LAN Card",
          • "DEVICE": "Wi-Fi",
          • "TYPE": "enet",
          • "MAC": "e9:4f:2b:90:a0:5c",
          • "IPS": [
            • "192.168.8.135",
            • "bcb6:a517:7ac1:7c98:0b51:bcd3:1183:82a8",
            • "3399:59b4:f568:cada:76b6:ee0c:7a0e:7a75",
            • "41c0:fdce:d075:df45:35b2:c995:7caa:73b8",
            • "44ea:9f49:34e0:ddb6:ec1c:a368:b398:4f03",
            • "c5e8:d9d2:91fb:7a69:843b:d575:7dc4:2f44"
            ]
          },
        • {
          • "TYPE": "enet",
          • "MAC": "e9:4f:2b:90:a0:5d",
          • "IPS": [ ],
          • "CONNECTED": false,
          • "VENDOR": "Bluetooth Device (Personal Area Network)",
          • "DEVICE": "Bluetooth Network Connection"
          },
        • {
          • "CONNECTED": false,
          • "VENDOR": "Microsoft Wi-Fi Direct Virtual Adapter",
          • "DEVICE": "",
          • "TYPE": "enet",
          • "MAC": "c3:1d:1d:e9:94:ef",
          • "IPS": [ ]
          },
        • {
          • "MAC": "c3:1d:1d:e9:a4:ff",
          • "IPS": [ ],
          • "CONNECTED": false,
          • "VENDOR": "Microsoft Wi-Fi Direct Virtual Adapter",
          • "DEVICE": "",
          • "TYPE": "enet"
          },
        • {
          • "CONNECTED": false,
          • "VENDOR": "WAN Miniport (IP)",
          • "DEVICE": "",
          • "TYPE": "enet",
          • "MAC": "4a:37:21:70:2e:f0",
          • "IPS": [ ]
          },
        • {
          • "IPS": [ ],
          • "CONNECTED": false,
          • "VENDOR": "WAN Miniport (IPv6)",
          • "DEVICE": "",
          • "TYPE": "enet",
          • "MAC": "bf:b5:ab:21:b8:63"
          },
        • {
          • "MAC": "cf:b6:ab:21:b8:63",
          • "IPS": [ ],
          • "CONNECTED": false,
          • "VENDOR": "WAN Miniport (Network Monitor)",
          • "DEVICE": "",
          • "TYPE": "enet"
          }
        ],
      • "WMI_INTEGRITY_CHECK": "True",
      • "SECURE_TOKEN_ACCOUNT": null,
      • "VOLUME": [
        • {
          • "FSTYPE": "NTFS",
          • "LABEL": "Windows-SSD",
          • "AVAIL": "509722226688",
          • "FREE": "408418480128",
          • "IS_SYSTEM_DISK": "True",
          • "VOLUME": "C:"
          }
        ],
      • "PS_VERSION": "5.1.26100.2161",
      • "UPDATE_SOURCE_CHECK": {
        • "CONNECTED": "True",
        • "ERROR": "Succeeded"
        },
      • "SERVICETAG": "No Asset Tag",
      • "SERIAL": "AB123ZX",
      • "DISKS": [
        • {
          • "TYPE": "Micron MTFDKCD512TFK",
          • "SIZE": "512105932800"
          }
        ],
      • "DISTINGUISHED_NAME": "",
      • "AUTO_UPDATE_OPTIONS": {
        • "OPTIONS": "off",
        • "ENABLED": "1"
        }
      },
    • "display_name": "TEST",
    • "exception": false,
    • "instance_id": "",
    • "ip_addrs": [
      • "123.45.67.210"
      ],
    • "ip_addrs_private": [
      • "192.168.8.135",
      • "bcb6:a517:7ac1:7c98:0b51:bcd3:1183:82a8",
      • "3399:59b4:f568:cada:76b6:ee0c:7a0e:7a75",
      • "41c0:fdce:d075:df45:35b2:c995:7caa:73b8",
      • "44ea:9f49:34e0:ddb6:ec1c:a368:b398:4f03",
      • "c5e8:d9d2:91fb:7a69:843b:d575:7dc4:2f44"
      ],
    • "is_compatible": true,
    • "is_delayed_by_notification": false,
    • "is_delayed_by_user": true,
    • "last_disconnect_time": "2025-01-22T22:18:21+0000",
    • "last_logged_in_user": "TEST\\john.doe",
    • "last_process_time": "2025-01-22T22:02:14+0000",
    • "last_refresh_time": "2025-01-22T20:10:26+0000",
    • "last_scan_failed": true,
    • "last_update_time": "2024-12-25T13:32:47+0000",
    • "mdm": null,
    • "name": "TEST",
    • "notes": "",
    • "needs_attention": false,
    • "needs_reboot": false,
    • "next_patch_time": "2025-01-23T06:02:00+0000",
    • "notification_count": 1,
    • "organization_id": 54321,
    • "organizational_unit": "",
    • "os_family": "Windows",
    • "os_name": "11 Home",
    • "os_version": "10.0.26100",
    • "os_version_id": 13235,
    • "patch_deferral_count": 1,
    • "patches": 2,
    • "pending": true,
    • "pending_patches": 2,
    • "policy_status": [
      • {
        • "id": 12121212,
        • "organization_id": 54321,
        • "policy_id": 250624,
        • "server_id": 123456,
        • "policy_name": "Apply All Patches",
        • "policy_type_name": "patch",
        • "status": 0,
        • "result": "{}",
        • "create_time": "2025-01-22T20:10:25+0000",
        • "will_reboot": false,
        • "pending_count": 0,
        • "next_remediation": null
        },
      • {
        • "id": 34343434,
        • "organization_id": 54321,
        • "policy_id": 901250,
        • "server_id": 123456,
        • "policy_name": "Apply Critical Patches",
        • "policy_type_name": "patch",
        • "status": 1,
        • "result": "{}",
        • "create_time": "2025-01-22T20:10:25+0000",
        • "will_reboot": false,
        • "pending_count": 0,
        • "next_remediation": null
        }
      ],
    • "reboot_deferral_count": 0,
    • "reboot_is_delayed_by_notification": false,
    • "reboot_is_delayed_by_user": false,
    • "reboot_notification_count": 0,
    • "refresh_interval": 360,
    • "serial_number": "AB123ZX",
    • "server_group_id": 654321,
    • "server_policies": [ ],
    • "status": {
      • "device_status": "not-ready",
      • "agent_status": "disconnected",
      • "policy_status": "non-compliant",
      • "policy_statuses": [
        • {
          • "id": 12121212,
          • "compliant": false
          },
        • {
          • "id": 34343434,
          • "compliant": true
          }
        ]
      },
    • "tags": [ ],
    • "timezone": "UTC-0500",
    • "total_count": 1,
    • "uptime": "170878",
    • "uuid": "1b597490-18f9-4ef4-957d-5e986921ebc1"
    }
]