-
Notifications
You must be signed in to change notification settings - Fork 0
/
12.0--asset_model-assets-GET.html
390 lines (249 loc) · 15.4 KB
/
12.0--asset_model-assets-GET.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
<!DOCTYPE html><html lang="en-us">
<head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta charset="UTF-8">
<meta name="dcterms.rights" content="© Copyright IBM Corporation 2022">
<meta name="description" content="This lists all assets found in the model. This endpoint supports sorting on id, domain_id, vulnerability_count and risk_score_sum, and filtering on all fields. EXCEPTION: LIKE, ILIKE, and BETWEEN do not work on the interfaces(ip_addresses(value)) field. It is possible to use the inequality operators to work around this in most cases. Use of the fields header to request only the necessary fields will improve API performance.">
<meta name="keywords" content="/asset_model/assets, GET, API, REST API">
<meta name="geo.country" content="ZZ">
<script>
digitalData = {
page: {
pageInfo: {
language: "en-us",
version: "v18",
ibm: {
country: "ZZ",
type: "CT701"
}
}
}
};
</script><!-- Licensed Materials - Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<link rel="stylesheet" type="text/css" href="ibmdita.css">
<link rel="Start" href="c_rest_api_version120_asset_model_intro.html">
<title>GET /asset_model/assets</title>
</head>
<body id="api-12.0--asset_model-assets-GET"><main role="main"><article role="article" aria-labelledby="d82708e10">
<h1 class="topictitle1" id="d82708e10">GET /asset_model/assets</h1>
<div class="body refbody"><p class="shortdesc">This lists all assets found in the model. This endpoint supports sorting on id, domain_id, vulnerability_count and risk_score_sum, and filtering on all fields. EXCEPTION: LIKE, ILIKE, and BETWEEN do not work on the interfaces(ip_addresses(value)) field. It is possible to use the inequality operators to work around this in most cases. Use of the fields header to request only the necessary fields will improve API performance.</p>
<div class="section refsyn">
<p>List all assets found in the model. This endpoint supports sorting on id, domain_id, vulnerability_count and risk_score_sum, and filtering on all fields. EXCEPTION: LIKE, ILIKE, and BETWEEN do not work on the interfaces(ip_addresses(value)) field. It is possible to use the inequality operators to work around this in most cases. Use of the fields header to request only the necessary fields will improve API performance.</p>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="GET /asset_model/assets resource details" class="defaultstyle"><caption><span class="tablecap">Table 1. GET /asset_model/assets resource details</span></caption><colgroup><col style="width:100%"></colgroup><thead style="text-align:left;">
<tr style="vertical-align:bottom;">
<th id="d82708e64" class="thbot">MIME Type</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="d82708e64 "><p>application/json
</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="GET /asset_model/assets request parameter details" class="defaultstyle"><caption><span class="tablecap">Table 2. GET /asset_model/assets request parameter details</span></caption><colgroup><col style="width:14.285714285714285%"><col style="width:14.285714285714285%"><col style="width:14.285714285714285%"><col style="width:14.285714285714285%"><col style="width:14.285714285714285%"><col style="width:28.57142857142857%"></colgroup><thead style="text-align:left;">
<tr style="vertical-align:bottom;">
<th id="d82708e112" class="thbot">Parameter</th>
<th id="d82708e115" class="thbot">Type</th>
<th id="d82708e118" class="thbot">Optionality</th>
<th id="d82708e121" class="thbot">Data Type</th>
<th id="d82708e124" class="thbot">MIME Type</th>
<th id="d82708e128" class="thbot">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="d82708e112 "><p>filter</p>
</td>
<td headers="d82708e115 "><p>query</p>
</td>
<td headers="d82708e118 "><p>Optional</p>
</td>
<td headers="d82708e121 "><p>String</p>
</td>
<td headers="d82708e124 "><p>text/plain</p>
</td>
<td headers="d82708e128 "><p>Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.</p>
</td>
</tr>
<tr>
<td headers="d82708e112 "><p>fields</p>
</td>
<td headers="d82708e115 "><p>query</p>
</td>
<td headers="d82708e118 "><p>Optional</p>
</td>
<td headers="d82708e121 "><p>String</p>
</td>
<td headers="d82708e124 "><p>text/plain</p>
</td>
<td headers="d82708e128 "><p>Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.</p>
</td>
</tr>
<tr>
<td headers="d82708e112 "><p>Range</p>
</td>
<td headers="d82708e115 "><p>header</p>
</td>
<td headers="d82708e118 "><p>Optional</p>
</td>
<td headers="d82708e121 "><p>String</p>
</td>
<td headers="d82708e124 "><p>text/plain</p>
</td>
<td headers="d82708e128 "><p>Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.</p>
</td>
</tr>
<tr>
<td headers="d82708e112 "><p>sort</p>
</td>
<td headers="d82708e115 "><p>query</p>
</td>
<td headers="d82708e118 "><p>Optional</p>
</td>
<td headers="d82708e121 "><p>String</p>
</td>
<td headers="d82708e124 "><p>text/plain</p>
</td>
<td headers="d82708e128 "><p>Optional - This parameter is used to sort the elements in a list.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="GET /asset_model/assets response codes" class="defaultstyle"><caption><span class="tablecap">Table 3. GET /asset_model/assets response codes</span></caption><colgroup><col style="width:20%"><col style="width:20%"><col style="width:60%"></colgroup><thead style="text-align:left;">
<tr style="vertical-align:bottom;">
<th id="d82708e274" class="thbot">HTTP Response Code</th>
<th id="d82708e277" class="thbot">Unique Code</th>
<th id="d82708e280" class="thbot">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="d82708e274 "><p>200</p>
</td>
<td headers="d82708e277 "><p></p>
</td>
<td headers="d82708e280 "><p>The request to retrieve assets completed
successfully.</p>
</td>
</tr>
<tr>
<td headers="d82708e274 "><p>500</p>
</td>
<td headers="d82708e277 "><p>1020</p>
</td>
<td headers="d82708e280 "><p>null</p>
</td>
</tr>
<tr>
<td headers="d82708e274 "><p>500</p>
</td>
<td headers="d82708e277 "><p>1021</p>
</td>
<td headers="d82708e280 "><p>null</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<section class="section refsyn" role="region" aria-labelledby="d82708e337"><h2 class="sectiontitle" id="d82708e337">Response Description</h2>
<div class="p">List of Asset objects with the following fields:
<ul>
<li><strong>id</strong> - Long - The ID of the asset.</li>
<li><strong>domain_id</strong> - Long - The ID of the domain this asset belongs to.</li>
<li><strong>vulnerability_count</strong> - Long - The total number of vulnerabilities associated with this asset</li>
<li><strong>risk_score_sum</strong> - Double - The sum of the CVSS scores of the vulnerabilities on this asset</li>
<li><strong>hostnames</strong> - Array - The hostnames on this asset
<ul>
<li><strong>id</strong> - Long - The ID of this hostname</li>
<li><strong>type</strong> - Enum - The type of hostname. One of "DNS", "NETBIOS", or "NETBIOSGROUP"</li>
<li><strong>name</strong> - String - The hostname</li>
<li><strong>last_scanned_for</strong> - Long - The time this hostname was created. This time is in milliseconds since epoch.</li>
<li><strong>first_seen_scanner</strong> - Long - The time this hostname was first seen during a vulnerability scan. This time is in milliseconds since epoch.</li>
<li><strong>first_seen_profiler</strong> - Long - The time this hostname was first seen in event or flow traffic. This time is in milliseconds since epoch.</li>
<li><strong>last_seen_scanner</strong> - Long - The time this hostname was most recently seen during a vulnerability scan. This time is in milliseconds since epoch.</li>
<li><strong>last_seen_profiler</strong> - Long - The time this hostname was most recently seen in event or flow traffic. This time is in milliseconds since epoch.</li>
</ul>
</li>
<li><strong>interfaces</strong> - Array - The interfaces on this asset
<ul>
<li><strong>id</strong> - Long - The ID of this interface</li>
<li><strong>mac_address</strong> - String - The mac address of this interface. Null if Unknown.</li>
<li><strong>ip_addresses</strong> - Array - The IP addresses on this interface
<ul>
<li><strong>id</strong> - Long - The ID of this interface</li>
<li><strong>network_id</strong> - Long - The ID of the network this IP address belongs to in QRadar's network hierarchy</li>
<li><strong>value</strong> - String - The IP address</li>
<li><strong>type</strong> - Enum - The type of this IP address. One of "IPV4" or "IPV6"</li>
<li><strong>ip_addresses</strong> - Array - The IP addresses on this interface</li>
<li><strong>created</strong> - Long - The time this IP address was created. This time is in milliseconds since epoch.</li>
<li><strong>first_seen_scanner</strong> - Long - The time this IP address was first seen during a vulnerability scan. This time is in milliseconds since epoch.</li>
<li><strong>first_seen_profiler</strong> - Long - The time this IP address was first seen in event or flow traffic. This time is in milliseconds since epoch.</li>
<li><strong>last_seen_scanner</strong> - Long - The time this IP address was most recently seen during a vulnerability scan. This time is in milliseconds since epoch.</li>
<li><strong>last_seen_profiler</strong> - Long - The time this IP address was most recently seen in event or flow traffic. This time is in milliseconds since epoch.</li>
</ul>
</li>
<li><strong>created</strong> - Long - The time this interface was created. This time is in milliseconds since epoch.</li>
<li><strong>first_seen_scanner</strong> - Long - The time this interface was first seen during a vulnerability scan. This time is in milliseconds since epoch.</li>
<li><strong>first_seen_profiler</strong> - Long - The time this interface was first seen in event or flow traffic. This time is in milliseconds since epoch.</li>
<li><strong>last_seen_scanner</strong> - Long - The time this interface was most recently seen during a vulnerability scan. This time is in milliseconds since epoch.</li>
<li><strong>last_seen_profiler</strong> - Long - The time this interface was most recently seen in event or flow traffic. This time is in milliseconds since epoch.</li>
</ul>
</li>
<li><strong>products</strong> - Array - The software products detected on this asset
<ul>
<li><strong>id</strong> - Long - The ID of this software product instance in QRadar's asset model</li>
<li><strong>product_variant_id</strong> - Long - The ID of this software product variant in QRadar's catalog of products.</li>
<li><strong>created</strong> - Long - The time this product was most recently scanned for. This time is in milliseconds since epoch.</li>
<li><strong>first_seen_scanner</strong> - Long - The time this product was first seen during a vulnerability scan. This time is in milliseconds since epoch.</li>
<li><strong>first_seen_profiler</strong> - Long - The time this product was first seen in event or flow traffic. This time is in milliseconds since epoch.</li>
<li><strong>last_seen_scanner</strong> - Long - The time this product was most recently seen during a vulnerability scan. This time is in milliseconds since epoch.</li>
<li><strong>last_seen_profiler</strong> - Long - The time this product was most recently seen in event or flow traffic. This time is in milliseconds since epoch.</li>
</ul>
</li>
<li><strong>properties</strong> - Array - Various system and custom properties on this asset
<ul>
<li><strong>id</strong> - Long - The ID of this property.</li>
<li><strong>type_id</strong> - Long - The ID of the type of this property</li>
<li><strong>name</strong> - String - The name of the type of this property</li>
<li><strong>value</strong> - String - The value of this property</li>
<li><strong>last_reported_by</strong> - String - The source of the most recent update to this property</li>
<li><strong>last_reported</strong> - Long - The time this property was last updated. This time is in milliseconds since epoch.</li>
</ul>
</li>
<li><strong>users</strong> - Array - The users associated with this asset
<ul>
<li><strong>id</strong> - Long - The ID of this username.</li>
<li><strong>username</strong> - String - The username.</li>
<li><strong>first_seen_scanner</strong> - Long - The time this username was first seen during a vulnerability scan. This time is in milliseconds since epoch.</li>
<li><strong>first_seen_profiler</strong> - Long - The time this username was first seen in event or flow traffic. This time is in milliseconds since epoch.</li>
<li><strong>last_seen_scanner</strong> - Long - The time this username was most recently seen during a vulnerability scan. This time is in milliseconds since epoch.</li>
<li><strong>last_seen_profiler</strong> - Long - The time this username was most recently seen in event or flow traffic. This time is in milliseconds since epoch.</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="section refsyn" role="region" aria-labelledby="d82708e643"><h2 class="sectiontitle" id="d82708e643">Response Sample</h2>
<pre class="codeblock"><code>
[{"vulnerability_count": 42, "interfaces": [{"mac_address": "String", "last_seen_profiler": 42, "created": 42, "first_seen_scanner": 42, "last_seen_scanner": 42, "ip_addresses": [{"last_seen_profiler": 42, "created": 42, "first_seen_scanner": 42, "last_seen_scanner": 42, "network_id": 42, "id": 42, "type": "String", "first_seen_profiler": 42, "value": "String"}], "id": 42, "first_seen_profiler": 42}], "risk_score_sum": 42.5, "hostnames": [{"last_seen_profiler": 42, "created": 42, "name": "String", "first_seen_scanner": 42, "last_seen_scanner": 42, "id": 42, "type": "String <one of: DNS, NETBIOS, NETBIOSGROUP>", "first_seen_profiler": 42}], "id": 42, "domain_id": 42, "properties": [{"last_reported": 42, "name": "String", "type_id": 42, "id": 42, "last_reported_by": "String", "value": "String"}], "users": [{"last_seen_profiler": 42, "first_seen_scanner": 42, "last_seen_scanner": 42, "id": 42, "first_seen_profiler": 42, "username": "String"}], "products": [{"last_scanned_for": 42, "last_seen_profiler": 42, "product_variant_id": 42, "first_seen_scanner": 42, "last_seen_scanner": 42, "id": 42, "first_seen_profiler": 42}]}]
</code></pre>
</section>
</div>
<aside role="complementary" aria-labelledby="d82708e10"><nav role="navigation">
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="c_rest_api_version120_asset_model_intro.html" title="Use the references for REST API 12.0 asset model endpoints.">Asset model endpoints</a></div>
</div>
</nav></aside></article></main></body></html>