Ruby / Datadog API Collection / Get all hosts for your organization
Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("filter","tempor Ut sed velit")
queryParams.UpdateString("sort_field","tempor Ut sed velit")
queryParams.UpdateString("sort_dir","tempor Ut sed velit")
queryParams.UpdateInt("start",-62147425)
queryParams.UpdateInt("count",-62147425)
queryParams.UpdateInt("from",-62147425)
queryParams.UpdateString("include_muted_hosts_data","true")
queryParams.UpdateString("include_hosts_metadata","true")
http.SetRequestHeader("Accept","application/json")
# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v1/hosts",queryParams)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "host_list": [
# {
# "aliases": [
# "mycoolhost-1",
# "mycoolhost-1"
# ],
# "apps": [
# "agent",
# "agent"
# ],
# "aws_name": "mycoolhost-1",
# "host_name": "i-deadbeef",
# "id": 123456,
# "is_muted": false,
# "last_reported_time": 1565000000,
# "meta": {
# "agent_checks": [
# [
# "ntp",
# "ntp",
# "ntp:d884b5186b651429",
# "OK",
# "",
# ""
# ],
# [
# "ntp",
# "ntp",
# "ntp:d884b5186b651429",
# "OK",
# "",
# ""
# ]
# ],
# "agent_version": "7.32.3",
# "cpuCores": 1,
# "fbsdV": [
# "FreeBSD",
# "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",
# "Mac"
# ],
# "machine": "amd64",
# "nixV": [
# "Ubuntu",
# "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",
# "Windows"
# ]
# },
# "metrics": {
# "cpu": 99,
# "iowait": 3.2,
# "load": 0.5
# },
# "mute_timeout": 29442737,
# "name": "i-hostname",
# "sources": [
# "aws",
# "aws"
# ],
# "tags_by_source": {
# "magna_": [
# "test.example.com.host",
# "test.example.com.host"
# ]
# },
# "up": true
# },
# {
# "aliases": [
# "mycoolhost-1",
# "mycoolhost-1"
# ],
# "apps": [
# "agent",
# "agent"
# ],
# "aws_name": "mycoolhost-1",
# "host_name": "i-deadbeef",
# "id": 123456,
# "is_muted": false,
# "last_reported_time": 1565000000,
# "meta": {
# "agent_checks": [
# [
# "ntp",
# "ntp",
# "ntp:d884b5186b651429",
# "OK",
# "",
# ""
# ],
# [
# "ntp",
# "ntp",
# "ntp:d884b5186b651429",
# "OK",
# "",
# ""
# ]
# ],
# "agent_version": "7.32.3",
# "cpuCores": 1,
# "fbsdV": [
# "FreeBSD",
# "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",
# "Mac"
# ],
# "machine": "amd64",
# "nixV": [
# "Ubuntu",
# "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",
# "Windows"
# ]
# },
# "metrics": {
# "cpu": 99,
# "iowait": 3.2,
# "load": 0.5
# },
# "mute_timeout": 54283511,
# "name": "i-hostname",
# "sources": [
# "aws",
# "aws"
# ],
# "tags_by_source": {
# "non_4e8": [
# "test.example.com.host",
# "test.example.com.host"
# ],
# "officia__d4": [
# "test.example.com.host",
# "test.example.com.host"
# ]
# },
# "up": true
# }
# ],
# "total_matching": 1,
# "total_returned": 1
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
total_matching = jResp.IntOf("total_matching")
total_returned = jResp.IntOf("total_returned")
i = 0
count_i = jResp.SizeOfArray("host_list")
while i < count_i
jResp.put_I(i)
aws_name = jResp.stringOf("host_list[i].aws_name")
host_name = jResp.stringOf("host_list[i].host_name")
id = jResp.IntOf("host_list[i].id")
is_muted = jResp.BoolOf("host_list[i].is_muted")
last_reported_time = jResp.IntOf("host_list[i].last_reported_time")
Agent_version = jResp.stringOf("host_list[i].meta.agent_version")
CpuCores = jResp.IntOf("host_list[i].meta.cpuCores")
Gohai = jResp.stringOf("host_list[i].meta.gohai")
Installer_version = jResp.stringOf("host_list[i].meta.install_method.installer_version")
Tool = jResp.stringOf("host_list[i].meta.install_method.tool")
Tool_version = jResp.stringOf("host_list[i].meta.install_method.tool_version")
Machine = jResp.stringOf("host_list[i].meta.machine")
Platform = jResp.stringOf("host_list[i].meta.platform")
Processor = jResp.stringOf("host_list[i].meta.processor")
PythonV = jResp.stringOf("host_list[i].meta.pythonV")
Socket_fqdn = jResp.stringOf("host_list[i].meta.socket-fqdn")
Socket_hostname = jResp.stringOf("host_list[i].meta.socket-hostname")
Cpu = jResp.IntOf("host_list[i].metrics.cpu")
Iowait = jResp.stringOf("host_list[i].metrics.iowait")
Load = jResp.stringOf("host_list[i].metrics.load")
mute_timeout = jResp.IntOf("host_list[i].mute_timeout")
name = jResp.stringOf("host_list[i].name")
up = jResp.BoolOf("host_list[i].up")
j = 0
count_j = jResp.SizeOfArray("host_list[i].aliases")
while j < count_j
jResp.put_J(j)
strVal = jResp.stringOf("host_list[i].aliases[j]")
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("host_list[i].apps")
while j < count_j
jResp.put_J(j)
strVal = jResp.stringOf("host_list[i].apps[j]")
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("host_list[i].meta.agent_checks")
while j < count_j
jResp.put_J(j)
k = 0
count_k = jResp.SizeOfArray("host_list[i].meta.agent_checks[j]")
while k < count_k
jResp.put_K(k)
strVal = jResp.stringOf("host_list[i].meta.agent_checks[j][k]")
k = k + 1
end
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("host_list[i].meta.fbsdV")
while j < count_j
jResp.put_J(j)
strVal = jResp.stringOf("host_list[i].meta.fbsdV[j]")
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("host_list[i].meta.macV")
while j < count_j
jResp.put_J(j)
strVal = jResp.stringOf("host_list[i].meta.macV[j]")
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("host_list[i].meta.nixV")
while j < count_j
jResp.put_J(j)
strVal = jResp.stringOf("host_list[i].meta.nixV[j]")
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("host_list[i].meta.winV")
while j < count_j
jResp.put_J(j)
strVal = jResp.stringOf("host_list[i].meta.winV[j]")
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("host_list[i].sources")
while j < count_j
jResp.put_J(j)
strVal = jResp.stringOf("host_list[i].sources[j]")
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("host_list[i].tags_by_source.magna_")
while j < count_j
jResp.put_J(j)
strVal = jResp.stringOf("host_list[i].tags_by_source.magna_[j]")
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("host_list[i].tags_by_source.non_4e8")
while j < count_j
jResp.put_J(j)
strVal = jResp.stringOf("host_list[i].tags_by_source.non_4e8[j]")
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("host_list[i].tags_by_source.officia__d4")
while j < count_j
jResp.put_J(j)
strVal = jResp.stringOf("host_list[i].tags_by_source.officia__d4[j]")
j = j + 1
end
i = i + 1
end
Curl Command
curl -G -d "filter=tempor%20Ut%20sed%20velit"
-d "sort_field=tempor%20Ut%20sed%20velit"
-d "sort_dir=tempor%20Ut%20sed%20velit"
-d "start=-62147425"
-d "count=-62147425"
-d "from=-62147425"
-d "include_muted_hosts_data=true"
-d "include_hosts_metadata=true"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/hosts
Postman Collection Item JSON
{
"name": "Get all hosts for your organization",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/hosts?filter=tempor Ut sed velit&sort_field=tempor Ut sed velit&sort_dir=tempor Ut sed velit&start=-62147425&count=-62147425&from=-62147425&include_muted_hosts_data=true&include_hosts_metadata=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"hosts"
],
"query": [
{
"key": "filter",
"value": "tempor Ut sed velit",
"description": "String to filter search results."
},
{
"key": "sort_field",
"value": "tempor Ut sed velit",
"description": "Sort hosts by this field."
},
{
"key": "sort_dir",
"value": "tempor Ut sed velit",
"description": "Direction of sort. Options include `asc` and `desc`."
},
{
"key": "start",
"value": "-62147425",
"description": "Host result to start search from."
},
{
"key": "count",
"value": "-62147425",
"description": "Number of hosts to return. Max 1000."
},
{
"key": "from",
"value": "-62147425",
"description": "Number of seconds since UNIX epoch from which you want to search your hosts."
},
{
"key": "include_muted_hosts_data",
"value": "true",
"description": "Include information on the muted status of hosts and when the mute expires."
},
{
"key": "include_hosts_metadata",
"value": "true",
"description": "Include additional metadata about the hosts (agent_version, machine, platform, processor, etc.)."
}
]
},
"description": "This endpoint allows searching for hosts by name, alias, or tag.\nHosts live within the past 3 hours are included by default.\nRetention is 7 days.\nResults are paginated with a max of 1000 results at a time."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/hosts?filter=tempor Ut sed velit&sort_field=tempor Ut sed velit&sort_dir=tempor Ut sed velit&start=-62147425&count=-62147425&from=-62147425&include_muted_hosts_data=true&include_hosts_metadata=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"hosts"
],
"query": [
{
"key": "filter",
"value": "tempor Ut sed velit",
"description": "String to filter search results."
},
{
"key": "sort_field",
"value": "tempor Ut sed velit",
"description": "Sort hosts by this field."
},
{
"key": "sort_dir",
"value": "tempor Ut sed velit",
"description": "Direction of sort. Options include `asc` and `desc`."
},
{
"key": "start",
"value": "-62147425",
"description": "Host result to start search from."
},
{
"key": "count",
"value": "-62147425",
"description": "Number of hosts to return. Max 1000."
},
{
"key": "from",
"value": "-62147425",
"description": "Number of seconds since UNIX epoch from which you want to search your hosts."
},
{
"key": "include_muted_hosts_data",
"value": "true",
"description": "Include information on the muted status of hosts and when the mute expires."
},
{
"key": "include_hosts_metadata",
"value": "true",
"description": "Include additional metadata about the hosts (agent_version, machine, platform, processor, etc.)."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"host_list\": [\n {\n \"aliases\": [\n \"mycoolhost-1\",\n \"mycoolhost-1\"\n ],\n \"apps\": [\n \"agent\",\n \"agent\"\n ],\n \"aws_name\": \"mycoolhost-1\",\n \"host_name\": \"i-deadbeef\",\n \"id\": 123456,\n \"is_muted\": false,\n \"last_reported_time\": 1565000000,\n \"meta\": {\n \"agent_checks\": [\n [\n \"ntp\",\n \"ntp\",\n \"ntp:d884b5186b651429\",\n \"OK\",\n \"\",\n \"\"\n ],\n [\n \"ntp\",\n \"ntp\",\n \"ntp:d884b5186b651429\",\n \"OK\",\n \"\",\n \"\"\n ]\n ],\n \"agent_version\": \"7.32.3\",\n \"cpuCores\": 1,\n \"fbsdV\": [\n \"FreeBSD\",\n \"FreeBSD\"\n ],\n \"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\\\"}}\",\n \"install_method\": {\n \"installer_version\": \"install_script-1.7.1\",\n \"tool\": \"install_script\",\n \"tool_version\": \"install_script\"\n },\n \"macV\": [\n \"Mac\",\n \"Mac\"\n ],\n \"machine\": \"amd64\",\n \"nixV\": [\n \"Ubuntu\",\n \"Ubuntu\"\n ],\n \"platform\": \"linux\",\n \"processor\": \"Intel(R) Core(TM) i7-8559U CPU @ 2.70GHz\",\n \"pythonV\": \"3.8.11\",\n \"socket-fqdn\": \"vagrant.vm.\",\n \"socket-hostname\": \"vagrant\",\n \"winV\": [\n \"Windows\",\n \"Windows\"\n ]\n },\n \"metrics\": {\n \"cpu\": 99,\n \"iowait\": 3.2,\n \"load\": 0.5\n },\n \"mute_timeout\": 29442737,\n \"name\": \"i-hostname\",\n \"sources\": [\n \"aws\",\n \"aws\"\n ],\n \"tags_by_source\": {\n \"magna_\": [\n \"test.example.com.host\",\n \"test.example.com.host\"\n ]\n },\n \"up\": true\n },\n {\n \"aliases\": [\n \"mycoolhost-1\",\n \"mycoolhost-1\"\n ],\n \"apps\": [\n \"agent\",\n \"agent\"\n ],\n \"aws_name\": \"mycoolhost-1\",\n \"host_name\": \"i-deadbeef\",\n \"id\": 123456,\n \"is_muted\": false,\n \"last_reported_time\": 1565000000,\n \"meta\": {\n \"agent_checks\": [\n [\n \"ntp\",\n \"ntp\",\n \"ntp:d884b5186b651429\",\n \"OK\",\n \"\",\n \"\"\n ],\n [\n \"ntp\",\n \"ntp\",\n \"ntp:d884b5186b651429\",\n \"OK\",\n \"\",\n \"\"\n ]\n ],\n \"agent_version\": \"7.32.3\",\n \"cpuCores\": 1,\n \"fbsdV\": [\n \"FreeBSD\",\n \"FreeBSD\"\n ],\n \"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\\\"}}\",\n \"install_method\": {\n \"installer_version\": \"install_script-1.7.1\",\n \"tool\": \"install_script\",\n \"tool_version\": \"install_script\"\n },\n \"macV\": [\n \"Mac\",\n \"Mac\"\n ],\n \"machine\": \"amd64\",\n \"nixV\": [\n \"Ubuntu\",\n \"Ubuntu\"\n ],\n \"platform\": \"linux\",\n \"processor\": \"Intel(R) Core(TM) i7-8559U CPU @ 2.70GHz\",\n \"pythonV\": \"3.8.11\",\n \"socket-fqdn\": \"vagrant.vm.\",\n \"socket-hostname\": \"vagrant\",\n \"winV\": [\n \"Windows\",\n \"Windows\"\n ]\n },\n \"metrics\": {\n \"cpu\": 99,\n \"iowait\": 3.2,\n \"load\": 0.5\n },\n \"mute_timeout\": 54283511,\n \"name\": \"i-hostname\",\n \"sources\": [\n \"aws\",\n \"aws\"\n ],\n \"tags_by_source\": {\n \"non_4e8\": [\n \"test.example.com.host\",\n \"test.example.com.host\"\n ],\n \"officia__d4\": [\n \"test.example.com.host\",\n \"test.example.com.host\"\n ]\n },\n \"up\": true\n }\n ],\n \"total_matching\": 1,\n \"total_returned\": 1\n}"
},
{
"name": "Invalid Parameter Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/hosts?filter=tempor Ut sed velit&sort_field=tempor Ut sed velit&sort_dir=tempor Ut sed velit&start=-62147425&count=-62147425&from=-62147425&include_muted_hosts_data=true&include_hosts_metadata=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"hosts"
],
"query": [
{
"key": "filter",
"value": "tempor Ut sed velit",
"description": "String to filter search results."
},
{
"key": "sort_field",
"value": "tempor Ut sed velit",
"description": "Sort hosts by this field."
},
{
"key": "sort_dir",
"value": "tempor Ut sed velit",
"description": "Direction of sort. Options include `asc` and `desc`."
},
{
"key": "start",
"value": "-62147425",
"description": "Host result to start search from."
},
{
"key": "count",
"value": "-62147425",
"description": "Number of hosts to return. Max 1000."
},
{
"key": "from",
"value": "-62147425",
"description": "Number of seconds since UNIX epoch from which you want to search your hosts."
},
{
"key": "include_muted_hosts_data",
"value": "true",
"description": "Include information on the muted status of hosts and when the mute expires."
},
{
"key": "include_hosts_metadata",
"value": "true",
"description": "Include additional metadata about the hosts (agent_version, machine, platform, processor, etc.)."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/hosts?filter=tempor Ut sed velit&sort_field=tempor Ut sed velit&sort_dir=tempor Ut sed velit&start=-62147425&count=-62147425&from=-62147425&include_muted_hosts_data=true&include_hosts_metadata=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"hosts"
],
"query": [
{
"key": "filter",
"value": "tempor Ut sed velit",
"description": "String to filter search results."
},
{
"key": "sort_field",
"value": "tempor Ut sed velit",
"description": "Sort hosts by this field."
},
{
"key": "sort_dir",
"value": "tempor Ut sed velit",
"description": "Direction of sort. Options include `asc` and `desc`."
},
{
"key": "start",
"value": "-62147425",
"description": "Host result to start search from."
},
{
"key": "count",
"value": "-62147425",
"description": "Number of hosts to return. Max 1000."
},
{
"key": "from",
"value": "-62147425",
"description": "Number of seconds since UNIX epoch from which you want to search your hosts."
},
{
"key": "include_muted_hosts_data",
"value": "true",
"description": "Include information on the muted status of hosts and when the mute expires."
},
{
"key": "include_hosts_metadata",
"value": "true",
"description": "Include additional metadata about the hosts (agent_version, machine, platform, processor, etc.)."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/hosts?filter=tempor Ut sed velit&sort_field=tempor Ut sed velit&sort_dir=tempor Ut sed velit&start=-62147425&count=-62147425&from=-62147425&include_muted_hosts_data=true&include_hosts_metadata=true",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"hosts"
],
"query": [
{
"key": "filter",
"value": "tempor Ut sed velit",
"description": "String to filter search results."
},
{
"key": "sort_field",
"value": "tempor Ut sed velit",
"description": "Sort hosts by this field."
},
{
"key": "sort_dir",
"value": "tempor Ut sed velit",
"description": "Direction of sort. Options include `asc` and `desc`."
},
{
"key": "start",
"value": "-62147425",
"description": "Host result to start search from."
},
{
"key": "count",
"value": "-62147425",
"description": "Number of hosts to return. Max 1000."
},
{
"key": "from",
"value": "-62147425",
"description": "Number of seconds since UNIX epoch from which you want to search your hosts."
},
{
"key": "include_muted_hosts_data",
"value": "true",
"description": "Include information on the muted status of hosts and when the mute expires."
},
{
"key": "include_hosts_metadata",
"value": "true",
"description": "Include additional metadata about the hosts (agent_version, machine, platform, processor, etc.)."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
