v1
latestOpenAPI 3.0.02026-07-142351,1971.3 MBGet all hosts for your organization
This endpoint allows searching for hosts by name, alias, or tag. Hosts live within the past 3 hours are included by default. Retention is 7 days. Results are paginated with a max of 1000 results at a time. Note: If the host is an Amazon EC2 instance, id is replaced with aws_id in the response. Note: To enrich the data returned by this endpoint with security scans, see the new api/v2/security/scanned-assets-metadata endpoint.
Query parameters
String to filter search results.
Sort hosts by this field.
Direction of sort. Options include asc and desc.
Specify the starting point for the host search results. For example, if you set count to 100 and the first 100 results have already been returned, you can set start to 101 to get the next 100 results.
Number of hosts to return. Max 1000.
Number of seconds since UNIX epoch from which you want to search your hosts.
Include information on the muted status of hosts and when the mute expires.
Include additional metadata about the hosts (agent_version, machine, platform, processor, etc.).
Response
OK
Example response
{
"host_list": [
{
"aliases": [
"mycoolhost-1"
],
"apps": [
"agent"
],
"aws_name": "mycoolhost-1",
"host_name": "i-deadbeef",
"id": 123456,
"last_reported_time": 1565000000,
"meta": {
"agent_checks": [
[
"ntp",
"ntp",
"ntp:d884b5186b651429",
"OK",
"",
""
]
],
"agent_version": "7.32.3",
"cpuCores": 1,
"fbsdV": [
"FreeBSD"
],
"gohai": "{\"cpu\":{\"cache_size\":\"8192 KB\",\"cpu_cores\":\"1\",\"cpu_logical_processors\":\"1\",\"family\":\"6\",\"mhz\":\"2712.000\",\"model\":\"142\",\"model_name\":\"Intel(R) Core(TM) i7-8559U CPU @ 2.70GHz\",\"stepping\":\"10\",\"vendor_id\":\"GenuineIntel\"},\"filesystem\":[{\"kb_size\":\"3966896\",\"mounted_on\":\"/dev\",\"name\":\"udev\"},{\"kb_size\":\"797396\",\"mounted_on\":\"/run\",\"name\":\"tmpfs\"},{\"kb_size\":\"64800356\",\"mounted_on\":\"/\",\"name\":\"/dev/mapper/vagrant--vg-root\"},{\"kb_size\":\"3986972\",\"mounted_on\":\"/dev/shm\",\"name\":\"tmpfs\"},{\"kb_size\":\"5120\",\"mounted_on\":\"/run/lock\",\"name\":\"tmpfs\"},{\"kb_size\":\"3986972\",\"mounted_on\":\"/sys/fs/cgroup\",\"name\":\"tmpfs\"},{\"kb_size\":\"488245288\",\"mounted_on\":\"/vagrant\",\"name\":\"vagrant\"},{\"kb_size\":\"797392\",\"mounted_on\":\"/run/user/1000\",\"name\":\"tmpfs\"}],\"memory\":{\"swap_total\":\"1003516kB\",\"total\":\"7973944kB\"},\"network\":{\"interfaces\":[{\"ipv4\":\"10.0.2.15\",\"ipv4-network\":\"10.0.2.0/24\",\"ipv6\":\"fe80::a00:27ff:fec2:be11\",\"ipv6-network\":\"fe80::/64\",\"macaddress\":\"08:00:27:c2:be:11\",\"name\":\"eth0\"},{\"ipv4\":\"192.168.122.1\",\"ipv4-network\":\"192.168.122.0/24\",\"macaddress\":\"52:54:00:6f:1c:bf\",\"name\":\"virbr0\"}],\"ipaddress\":\"10.0.2.15\",\"ipaddressv6\":\"fe80::a00:27ff:fec2:be11\",\"macaddress\":\"08:00:27:c2:be:11\"},\"platform\":{\"GOOARCH\":\"amd64\",\"GOOS\":\"linux\",\"goV\":\"1.16.7\",\"hardware_platform\":\"x86_64\",\"hostname\":\"vagrant\",\"kernel_name\":\"Linux\",\"kernel_release\":\"4.15.0-29-generic\",\"kernel_version\":\"#31-Ubuntu SMP Tue Jul 17 15:39:52 UTC 2018\",\"machine\":\"x86_64\",\"os\":\"GNU/Linux\",\"processor\":\"x86_64\",\"pythonV\":\"2.7.15rc1\"}}",
"install_method": {
"installer_version": "install_script-1.7.1",
"tool": "install_script",
"tool_version": "install_script"
},
"macV": [
"Mac"
],
"machine": "amd64",
"nixV": [
"Ubuntu"
],
"platform": "linux",
"processor": "Intel(R) Core(TM) i7-8559U CPU @ 2.70GHz",
"pythonV": "3.8.11",
"socket-fqdn": "vagrant.vm.",
"socket-hostname": "vagrant",
"winV": [
"Windows"
]
},
"metrics": {
"cpu": 99,
"iowait": 3.2,
"load": 0.5
},
"name": "i-hostname",
"sources": [
"aws"
],
"up": true
}
],
"total_matching": 1,
"total_returned": 1
}