List all devices

Retrieves a detailed list of all devices (server objects) for the authenticated user.

SecuritybearerAuth
Request
query Parameters
groupId
integer

Filter based on membership to a specific Server Group ID

PS_VERSION
integer

Shows version of PowerShell running on the device, if applicable.

o
required
integer

Organization ID. Response will include devices for the specified Automox Organization. The organization will be assumed based on the API key, if not specified.

pending
integer

Filter based on status of pending patches. Format: pending=1

Enum: 0 1
patchStatus
string
Default: "missing"

Filter based on presence of ANY available patches that aren't already installed. Value must be 'missing' Format: patchStatus=missing

policyId
integer

Filter based on association to a given Policy ID. Format: policyId=12345

exception
integer

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

Enum: 0 1
managed
integer

Filter based on device's Managed status. Unmanaged indicates no linked policies. Format: managed=0

Enum: 0 1
limit
required
integer [ 1 .. 500 ]
Default: 500

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

page
required
integer
Default: 0

The page of results you wish to be returned with page numbers starting at 0. See About Automox API - Pagination

object

Filter on compatible devices

sortColumns[]
string

The column you want to sort by.

Value: "is_compatible"
sortDir
string

The sort direction, ascending or descending.

Enum Value Description
asc

Ascending order

desc

Descending order

Responses
200

successful operation

400

Invalid Request

401

Access token is missing or invalid

403

You do not have permission to perform this action.

404

Entity not found

429

Too many requests

503

Service Unavailable

default

Invalid Request

get/servers
Request samples 
$apiKey = 'your_automox_api_key'
$headers = @{ "Authorization" = "Bearer $apiKey" }
$url = "https://console.automox.com/api/servers?o=:orgID&page=0&limit=500"
$response = (Invoke-WebRequest -Method Get -Uri $url -Headers $headers).Content
Response samples
application/json
[
  • {
    • "id": 123456,
    • "os_version_id": 0,
    • "server_group_id": 0,
    • "organization_id": 0,
    • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    • "name": "string",
    • "instance_id": "string",
    • "refresh_interval": 240,
    • "last_update_time": "string",
    • "last_refresh_time": "string",
    • "uptime": 0,
    • "needs_reboot": true,
    • "timezone": "string",
    • "tags": [
      • "string"
      ],
    • "deleted": true,
    • "create_time": "2019-08-24T14:15:22Z",
    • "os_version": "string",
    • "os_name": "string",
    • "os_family": "string",
    • "ip_addrs": [
      • "string"
      ],
    • "ip_addrs_private": [
      • "string"
      ],
    • "patches": 0,
    • "detail": {
      • "CPU": "string",
      • "DISKS": [
        • {
          • "SIZE": "string",
          • "TYPE": "string"
          }
        ],
      • "MODEL": "string",
      • "NICS": [
        • {
          • "CONNECTED": true,
          • "DEVICE": "string",
          • "IPS": [
            • "string"
            ],
          • "MAC": "string",
          • "TYPE": "string",
          • "VENDOR": "string"
          }
        ],
      • "RAM": "string",
      • "SERIAL": "string",
      • "SERVICETAG": "string",
      • "VENDOR": "string",
      • "VERSION": "string"
      },
    • "agent_version": "string",
    • "custom_name": "string",
    • "exception": true,
    • "total_count": 0,
    • "is_compatible": true,
    • "compatibility_checks": {
      • "low_diskspace": true,
      • "missing_secure_token": true,
      • "app_store_disconnected": true,
      • "missing_powershell": true,
      • "missing_wmi_integrity_check": true,
      • "wsus_disconnected": true,
      • "windows_update_server_disconnected": true
      },
    • "policy_status": [
      • {
        • "id": 0,
        • "organization_id": 0,
        • "policy_id": 0,
        • "server_id": 0,
        • "policy_name": "string",
        • "policy_type_name": "patch",
        • "status": 0,
        • "result": "string",
        • "create_time": "string"
        }
      ],
    • "last_scan_failed": true,
    • "pending": true,
    • "compliant": true,
    • "display_name": "string",
    • "commands": [
      • {
        • "command_type_name": "InstallUpdate",
        • "args": "KB12345 KB67890",
        • "exec_time": "2017-06-29T16:39:50.951Z"
        }
      ],
    • "pending_patches": 0,
    • "connected": true,
    • "last_process_time": "string",
    • "next_patch_time": "string",
    • "notification_count": 0,
    • "reboot_notification_count": 0,
    • "patch_deferral_count": 0,
    • "is_delayed_by_notification": true,
    • "reboot_is_delayed_by_notification": true,
    • "is_delayed_by_user": true,
    • "reboot_is_delayed_by_user": true,
    • "last_disconnect_time": "2019-08-24T14:15:22Z",
    • "needs_attention": true,
    • "serial_number": "string",
    • "status": {
      • "device_status": "string",
      • "agent_status": "string",
      • "policy_status": "string",
      • "policy_statuses": [
        • {
          • "id": 0,
          • "compliant": true
          }
        ]
      },
    • "last_logged_in_user": "string"
    }
]