SQL Server / Datadog API Collection / Get all hosts for your organization
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @queryParams int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'filter', 'tempor Ut sed velit'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'sort_field', 'tempor Ut sed velit'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'sort_dir', 'tempor Ut sed velit'
EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'start', -62147425
EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'count', -62147425
EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'from', -62147425
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'include_muted_hosts_data', 'true'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'include_hosts_metadata', 'true'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://api.app.ddog-gov.com/api/v1/hosts', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- 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
DECLARE @aws_name nvarchar(4000)
DECLARE @host_name nvarchar(4000)
DECLARE @id int
DECLARE @is_muted int
DECLARE @last_reported_time int
DECLARE @Agent_version nvarchar(4000)
DECLARE @CpuCores int
DECLARE @Gohai nvarchar(4000)
DECLARE @Installer_version nvarchar(4000)
DECLARE @Tool nvarchar(4000)
DECLARE @Tool_version nvarchar(4000)
DECLARE @Machine nvarchar(4000)
DECLARE @Platform nvarchar(4000)
DECLARE @Processor nvarchar(4000)
DECLARE @PythonV nvarchar(4000)
DECLARE @Socket_fqdn nvarchar(4000)
DECLARE @Socket_hostname nvarchar(4000)
DECLARE @Cpu int
DECLARE @Iowait nvarchar(4000)
DECLARE @Load nvarchar(4000)
DECLARE @mute_timeout int
DECLARE @name nvarchar(4000)
DECLARE @up int
DECLARE @j int
DECLARE @count_j int
DECLARE @strVal nvarchar(4000)
DECLARE @k int
DECLARE @count_k int
DECLARE @total_matching int
EXEC sp_OAMethod @jResp, 'IntOf', @total_matching OUT, 'total_matching'
DECLARE @total_returned int
EXEC sp_OAMethod @jResp, 'IntOf', @total_returned OUT, 'total_returned'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'host_list'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @aws_name OUT, 'host_list[i].aws_name'
EXEC sp_OAMethod @jResp, 'StringOf', @host_name OUT, 'host_list[i].host_name'
EXEC sp_OAMethod @jResp, 'IntOf', @id OUT, 'host_list[i].id'
EXEC sp_OAMethod @jResp, 'BoolOf', @is_muted OUT, 'host_list[i].is_muted'
EXEC sp_OAMethod @jResp, 'IntOf', @last_reported_time OUT, 'host_list[i].last_reported_time'
EXEC sp_OAMethod @jResp, 'StringOf', @Agent_version OUT, 'host_list[i].meta.agent_version'
EXEC sp_OAMethod @jResp, 'IntOf', @CpuCores OUT, 'host_list[i].meta.cpuCores'
EXEC sp_OAMethod @jResp, 'StringOf', @Gohai OUT, 'host_list[i].meta.gohai'
EXEC sp_OAMethod @jResp, 'StringOf', @Installer_version OUT, 'host_list[i].meta.install_method.installer_version'
EXEC sp_OAMethod @jResp, 'StringOf', @Tool OUT, 'host_list[i].meta.install_method.tool'
EXEC sp_OAMethod @jResp, 'StringOf', @Tool_version OUT, 'host_list[i].meta.install_method.tool_version'
EXEC sp_OAMethod @jResp, 'StringOf', @Machine OUT, 'host_list[i].meta.machine'
EXEC sp_OAMethod @jResp, 'StringOf', @Platform OUT, 'host_list[i].meta.platform'
EXEC sp_OAMethod @jResp, 'StringOf', @Processor OUT, 'host_list[i].meta.processor'
EXEC sp_OAMethod @jResp, 'StringOf', @PythonV OUT, 'host_list[i].meta.pythonV'
EXEC sp_OAMethod @jResp, 'StringOf', @Socket_fqdn OUT, 'host_list[i].meta.socket-fqdn'
EXEC sp_OAMethod @jResp, 'StringOf', @Socket_hostname OUT, 'host_list[i].meta.socket-hostname'
EXEC sp_OAMethod @jResp, 'IntOf', @Cpu OUT, 'host_list[i].metrics.cpu'
EXEC sp_OAMethod @jResp, 'StringOf', @Iowait OUT, 'host_list[i].metrics.iowait'
EXEC sp_OAMethod @jResp, 'StringOf', @Load OUT, 'host_list[i].metrics.load'
EXEC sp_OAMethod @jResp, 'IntOf', @mute_timeout OUT, 'host_list[i].mute_timeout'
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'host_list[i].name'
EXEC sp_OAMethod @jResp, 'BoolOf', @up OUT, 'host_list[i].up'
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'host_list[i].aliases'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'host_list[i].aliases[j]'
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'host_list[i].apps'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'host_list[i].apps[j]'
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'host_list[i].meta.agent_checks'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
SELECT @k = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_k OUT, 'host_list[i].meta.agent_checks[j]'
WHILE @k < @count_k
BEGIN
EXEC sp_OASetProperty @jResp, 'K', @k
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'host_list[i].meta.agent_checks[j][k]'
SELECT @k = @k + 1
END
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'host_list[i].meta.fbsdV'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'host_list[i].meta.fbsdV[j]'
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'host_list[i].meta.macV'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'host_list[i].meta.macV[j]'
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'host_list[i].meta.nixV'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'host_list[i].meta.nixV[j]'
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'host_list[i].meta.winV'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'host_list[i].meta.winV[j]'
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'host_list[i].sources'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'host_list[i].sources[j]'
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'host_list[i].tags_by_source.magna_'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'host_list[i].tags_by_source.magna_[j]'
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'host_list[i].tags_by_source.non_4e8'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'host_list[i].tags_by_source.non_4e8[j]'
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'host_list[i].tags_by_source.officia__d4'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'host_list[i].tags_by_source.officia__d4[j]'
SELECT @j = @j + 1
END
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
