External DocumentationTo learn more, visit the Huntress documentation.
Basic Parameters
Advanced Parameters
Example Output
Workflow Library Example
List Agents with Huntress and Send Results Via EmailPreview this Workflow on desktop
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
| Parameter | Description |
|---|---|
| Hostname | The hostname of the endpoint to filter the agents by. |
| Limit | The maximum number of results to return per page. Defaults to 10, with a minimum of 1 and a maximum of 500. |
| Organization ID | The ID of the organization to filter the results by. |
| Page Token | The token used to retrieve the next page of results. |
| Platform | Select the platform to filter the agents by. |
| Return All Pages | Automatically fetch all resources, page by page. |
| Sort Direction | Select the sort direction for the results. |
| Sort Field | Select the field to sort the results by. |
| Parameter | Description |
|---|---|
| OS | The operating system to filter the agents by. |
| Version | The agent software version to filter the agents by. |
{
"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",
"last_callback_at": "2022-03-01T20:05:10Z",
"last_survey_at": "2022-03-01T20:05:10Z",
"mac_addresses": [
"7c:a7:b0:16:2f:78"
],
"service_pack_major": 0,
"service_pack_minor": 0,
"organization_id": 7,
"os": "Windows 8 Pro",
"os_build_version": "19044",
"os_major": 6,
"os_minor": 2,
"os_patch": 0,
"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
}
],
"pagination": {
"next_page_url": "string",
"next_page_token": "string"
}
}
Was this page helpful?