Sign in
latestSwagger 2.02026-08-109450223.9 KB

94acb422c07d

Agents

List Agents

Shows Agents associated with your account.

Note: This endpoint will also return a pagination key on the root level.
Please refer to the pagination section within our docs for more information.

get/v1/agents

Query parameters

limitinteger

Max number of resources returned in a paged collection. Defaults to 10, with a minimum of 1 and maximum 500.

page_tokenstring

Token used to request the next page in paginated results. Defaults to 'null'

sort_field'id' | 'created_at' | 'updated_at'

Field to sort by. Defaults to 'id'.

sort_direction'asc' | 'desc'

Sort direction. Defaults to 'desc'.

organization_idinteger

Filter by organization ID within Huntress account

platform'windows' | 'darwin' | 'linux'

Filter by platform. One of windows, darwin, linux

hostnamestring

Filter by hostname.

osstring

Filter by operating system.

versionstring

Filter by agent version.

Response

List Agents

Example response

{
  "agents": [
    {
      "id": 1,
      "account_id": 5,
      "arch": "x86_64",
      "created_at": "2022-03-01T20:05:10Z",
      "domain_name": "WORKGROUP",
      "edr_version": "0.3.20",
      "external_ip": "198.51.100.42",
      "hostname": "laptop01",
      "defender_policy_status": "Compliant",
      "defender_status": "Healthy",
      "defender_substatus": "Up to date",
      "firewall_status": "Disabled",
      "tamper_protection_configured": true,
      "tamper_protection_actual": true,
      "ipv4_address": "146.134.139.9",
      "ipv4_addresses": [
        "10.5.80.97",
        "172.27.240.1"
      ],
      "last_callback_at": "2022-03-01T20:05:10Z",
      "last_survey_at": "2022-03-01T20:05:10Z",
      "mac_addresses": [
        "7c:a7:b0:16:2f:78"
      ],
      "organization_id": 7,
      "os": "Windows 8 Pro",
      "os_build_version": "19044",
      "os_major": 6,
      "os_minor": 2,
      "platform": "windows",
      "serial_number": "wtIe1bvDbh",
      "tags": [
        "Server",
        "Production"
      ],
      "updated_at": "2022-03-01T20:05:10Z",
      "version": "0.11.3",
      "version_number": 720899,
      "win_build_number": 19044
    }
  ]
}