wazuh-ruby-client 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (86) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +20 -0
  3. data/.rspec +3 -0
  4. data/.travis.yml +7 -0
  5. data/CHANGELOG.md +0 -0
  6. data/Gemfile +5 -0
  7. data/LICENSE +21 -0
  8. data/README.md +74 -0
  9. data/Rakefile +6 -0
  10. data/docs/.nojekyll +0 -0
  11. data/docs/Wazuh/Api/Endpoints/ActiveResponse.html +278 -0
  12. data/docs/Wazuh/Api/Endpoints/Agents.html +1877 -0
  13. data/docs/Wazuh/Api/Endpoints/Cache.html +415 -0
  14. data/docs/Wazuh/Api/Endpoints/Ciscat.html +418 -0
  15. data/docs/Wazuh/Api/Endpoints/Cluster.html +2270 -0
  16. data/docs/Wazuh/Api/Endpoints/Decoders.html +860 -0
  17. data/docs/Wazuh/Api/Endpoints/Experimental.html +2610 -0
  18. data/docs/Wazuh/Api/Endpoints/Lists.html +452 -0
  19. data/docs/Wazuh/Api/Endpoints/Manager.html +1596 -0
  20. data/docs/Wazuh/Api/Endpoints/Rootcheck.html +1025 -0
  21. data/docs/Wazuh/Api/Endpoints/Rules.html +872 -0
  22. data/docs/Wazuh/Api/Endpoints/SecurityConfigurationAssessment.html +680 -0
  23. data/docs/Wazuh/Api/Endpoints/Summary.html +199 -0
  24. data/docs/Wazuh/Api/Endpoints/Syscheck.html +755 -0
  25. data/docs/Wazuh/Api/Endpoints/Syscollector.html +2069 -0
  26. data/docs/Wazuh/Api/Endpoints.html +292 -0
  27. data/docs/Wazuh/Api/Errors/TooManyRequestsError.html +398 -0
  28. data/docs/Wazuh/Api/Errors/WazuhError.html +290 -0
  29. data/docs/Wazuh/Api/Errors.html +117 -0
  30. data/docs/Wazuh/Api.html +133 -0
  31. data/docs/Wazuh/Client.html +521 -0
  32. data/docs/Wazuh/Config.html +223 -0
  33. data/docs/Wazuh/Faraday/Connection.html +110 -0
  34. data/docs/Wazuh/Faraday/Request.html +335 -0
  35. data/docs/Wazuh/Faraday/Response/RaiseError.html +191 -0
  36. data/docs/Wazuh/Faraday/Response.html +115 -0
  37. data/docs/Wazuh/Faraday.html +117 -0
  38. data/docs/Wazuh/Logger.html +201 -0
  39. data/docs/Wazuh.html +256 -0
  40. data/docs/WazuhRubyClient.html +121 -0
  41. data/docs/_index.html +391 -0
  42. data/docs/class_list.html +51 -0
  43. data/docs/css/common.css +1 -0
  44. data/docs/css/full_list.css +58 -0
  45. data/docs/css/style.css +496 -0
  46. data/docs/file.README.html +142 -0
  47. data/docs/file_list.html +56 -0
  48. data/docs/frames.html +17 -0
  49. data/docs/index.html +142 -0
  50. data/docs/js/app.js +292 -0
  51. data/docs/js/full_list.js +216 -0
  52. data/docs/js/jquery.js +4 -0
  53. data/docs/method_list.html +1059 -0
  54. data/docs/top-level-namespace.html +110 -0
  55. data/lib/tasks/api.rake +78 -0
  56. data/lib/wazuh/api/endpoints/active_response.rb +22 -0
  57. data/lib/wazuh/api/endpoints/agents.rb +175 -0
  58. data/lib/wazuh/api/endpoints/cache.rb +38 -0
  59. data/lib/wazuh/api/endpoints/ciscat.rb +43 -0
  60. data/lib/wazuh/api/endpoints/cluster.rb +199 -0
  61. data/lib/wazuh/api/endpoints/decoders.rb +91 -0
  62. data/lib/wazuh/api/endpoints/experimental.rb +309 -0
  63. data/lib/wazuh/api/endpoints/lists.rb +42 -0
  64. data/lib/wazuh/api/endpoints/manager.rb +156 -0
  65. data/lib/wazuh/api/endpoints/rootcheck.rb +93 -0
  66. data/lib/wazuh/api/endpoints/rules.rb +80 -0
  67. data/lib/wazuh/api/endpoints/security_configuration_assessment.rb +73 -0
  68. data/lib/wazuh/api/endpoints/summary.rb +15 -0
  69. data/lib/wazuh/api/endpoints/syscheck.rb +75 -0
  70. data/lib/wazuh/api/endpoints/syscollector.rb +227 -0
  71. data/lib/wazuh/api/endpoints.rb +37 -0
  72. data/lib/wazuh/api/error.rb +6 -0
  73. data/lib/wazuh/api/errors/too_many_requests_error.rb +22 -0
  74. data/lib/wazuh/api/errors/wazuh_error.rb +14 -0
  75. data/lib/wazuh/client.rb +27 -0
  76. data/lib/wazuh/config.rb +42 -0
  77. data/lib/wazuh/faraday/connection.rb +38 -0
  78. data/lib/wazuh/faraday/request.rb +38 -0
  79. data/lib/wazuh/faraday/response/raise_error.rb +11 -0
  80. data/lib/wazuh/logger.rb +13 -0
  81. data/lib/wazuh/version.rb +4 -0
  82. data/lib/wazuh-ruby-client/version.rb +3 -0
  83. data/lib/wazuh-ruby-client.rb +17 -0
  84. data/lib/wazuh_ruby_client.rb +2 -0
  85. data/wazuh-ruby-client.gemspec +43 -0
  86. metadata +200 -0
data/docs/Wazuh/Api/Endpoints/Syscheck.html ADDED
@@ -0,0 +1,755 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Module: Wazuh::Api::Endpoints::Syscheck
8
+
9
+ &mdash; Documentation by YARD 0.9.16
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "Wazuh::Api::Endpoints::Syscheck";
19
+ relpath = '../../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../../_index.html">Index (S)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../../Wazuh.html" title="Wazuh (module)">Wazuh</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Api.html" title="Wazuh::Api (module)">Api</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Endpoints.html" title="Wazuh::Api::Endpoints (module)">Endpoints</a></span></span>
41
+ &raquo;
42
+ <span class="title">Syscheck</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Module: Wazuh::Api::Endpoints::Syscheck
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+ <dl>
78
+ <dt>Included in:</dt>
79
+ <dd><span class='object_link'><a href="../Endpoints.html" title="Wazuh::Api::Endpoints (module)">Wazuh::Api::Endpoints</a></span></dd>
80
+ </dl>
81
+
82
+
83
+
84
+ <dl>
85
+ <dt>Defined in:</dt>
86
+ <dd>lib/wazuh/api/endpoints/syscheck.rb</dd>
87
+ </dl>
88
+
89
+ </div>
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+ <h2>
100
+ Instance Method Summary
101
+ <small><a href="#" class="summary_toggle">collapse</a></small>
102
+ </h2>
103
+
104
+ <ul class="summary">
105
+
106
+ <li class="public ">
107
+ <span class="summary_signature">
108
+
109
+ <a href="#clear_syscheck_database-instance_method" title="#clear_syscheck_database (instance method)">#<strong>clear_syscheck_database</strong>(agent_id) &#x21d2; Object </a>
110
+
111
+
112
+
113
+ </span>
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+ <span class="summary_desc"><div class='inline'>
124
+ <p>Clears the syscheck database for the specified agent.</p>
125
+ </div></span>
126
+
127
+ </li>
128
+
129
+
130
+ <li class="public ">
131
+ <span class="summary_signature">
132
+
133
+ <a href="#last_syscheck_scan-instance_method" title="#last_syscheck_scan (instance method)">#<strong>last_syscheck_scan</strong>(agent_id) &#x21d2; Object </a>
134
+
135
+
136
+
137
+ </span>
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+ <span class="summary_desc"><div class='inline'>
148
+ <p>Return the timestamp of the last syscheck scan.</p>
149
+ </div></span>
150
+
151
+ </li>
152
+
153
+
154
+ <li class="public ">
155
+ <span class="summary_signature">
156
+
157
+ <a href="#run_syscheck-instance_method" title="#run_syscheck (instance method)">#<strong>run_syscheck</strong>(agent_id) &#x21d2; Object </a>
158
+
159
+
160
+
161
+ </span>
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+ <span class="summary_desc"><div class='inline'>
172
+ <p>Runs syscheck and rootcheck on an agent (Wazuh launches both processes
173
+ simultaneously).</p>
174
+ </div></span>
175
+
176
+ </li>
177
+
178
+
179
+ <li class="public ">
180
+ <span class="summary_signature">
181
+
182
+ <a href="#run_syscheck_all_agents-instance_method" title="#run_syscheck_all_agents (instance method)">#<strong>run_syscheck_all_agents</strong> &#x21d2; Object </a>
183
+
184
+
185
+
186
+ </span>
187
+
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+
196
+ <span class="summary_desc"><div class='inline'>
197
+ <p>Runs syscheck and rootcheck on all agents (Wazuh launches both processes
198
+ simultaneously).</p>
199
+ </div></span>
200
+
201
+ </li>
202
+
203
+
204
+ <li class="public ">
205
+ <span class="summary_signature">
206
+
207
+ <a href="#syscheck_files-instance_method" title="#syscheck_files (instance method)">#<strong>syscheck_files</strong>(agent_id, options) &#x21d2; Object </a>
208
+
209
+
210
+
211
+ </span>
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+ <span class="summary_desc"><div class='inline'>
222
+ <p>Returns the syscheck files of an agent.</p>
223
+ </div></span>
224
+
225
+ </li>
226
+
227
+
228
+ </ul>
229
+
230
+
231
+
232
+
233
+ <div id="instance_method_details" class="method_details_list">
234
+ <h2>Instance Method Details</h2>
235
+
236
+
237
+ <div class="method_details first">
238
+ <h3 class="signature first" id="clear_syscheck_database-instance_method">
239
+
240
+ #<strong>clear_syscheck_database</strong>(agent_id) &#x21d2; <tt>Object</tt>
241
+
242
+
243
+
244
+
245
+
246
+ </h3><div class="docstring">
247
+ <div class="discussion">
248
+
249
+ <p>Clears the syscheck database for the specified agent.</p>
250
+
251
+
252
+ </div>
253
+ </div>
254
+ <div class="tags">
255
+ <p class="tag_title">Parameters:</p>
256
+ <ul class="param">
257
+
258
+ <li>
259
+
260
+ <span class='name'>agent_id</span>
261
+
262
+
263
+ <span class='type'>(<tt>String</tt>)</span>
264
+
265
+
266
+
267
+ &mdash;
268
+ <div class='inline'>
269
+ <p>ID to agent</p>
270
+ </div>
271
+
272
+ </li>
273
+
274
+ </ul>
275
+
276
+
277
+ <p class="tag_title">See Also:</p>
278
+ <ul class="see">
279
+
280
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#clear-syscheck-database-of-an-agent" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#clear-syscheck-database-of-an-agent">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#clear-syscheck-database-of-an-agent</a></li>
281
+
282
+ </ul>
283
+
284
+ </div><table class="source_code">
285
+ <tr>
286
+ <td>
287
+ <pre class="lines">
288
+
289
+
290
+ 11
291
+ 12
292
+ 13</pre>
293
+ </td>
294
+ <td>
295
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/syscheck.rb', line 11</span>
296
+
297
+ <span class='kw'>def</span> <span class='id identifier rubyid_clear_syscheck_database'>clear_syscheck_database</span><span class='lparen'>(</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='rparen'>)</span>
298
+ <span class='id identifier rubyid_delete'>delete</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/syscheck/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
299
+ <span class='kw'>end</span></pre>
300
+ </td>
301
+ </tr>
302
+ </table>
303
+ </div>
304
+
305
+ <div class="method_details ">
306
+ <h3 class="signature " id="last_syscheck_scan-instance_method">
307
+
308
+ #<strong>last_syscheck_scan</strong>(agent_id) &#x21d2; <tt>Object</tt>
309
+
310
+
311
+
312
+
313
+
314
+ </h3><div class="docstring">
315
+ <div class="discussion">
316
+
317
+ <p>Return the timestamp of the last syscheck scan.</p>
318
+
319
+
320
+ </div>
321
+ </div>
322
+ <div class="tags">
323
+ <p class="tag_title">Parameters:</p>
324
+ <ul class="param">
325
+
326
+ <li>
327
+
328
+ <span class='name'>agent_id</span>
329
+
330
+
331
+ <span class='type'>(<tt>String</tt>)</span>
332
+
333
+
334
+
335
+ &mdash;
336
+ <div class='inline'>
337
+ <p>ID to agent</p>
338
+ </div>
339
+
340
+ </li>
341
+
342
+ </ul>
343
+
344
+
345
+ <p class="tag_title">See Also:</p>
346
+ <ul class="see">
347
+
348
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-last-syscheck-scan" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-last-syscheck-scan">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-last-syscheck-scan</a></li>
349
+
350
+ </ul>
351
+
352
+ </div><table class="source_code">
353
+ <tr>
354
+ <td>
355
+ <pre class="lines">
356
+
357
+
358
+ 20
359
+ 21
360
+ 22</pre>
361
+ </td>
362
+ <td>
363
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/syscheck.rb', line 20</span>
364
+
365
+ <span class='kw'>def</span> <span class='id identifier rubyid_last_syscheck_scan'>last_syscheck_scan</span><span class='lparen'>(</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='rparen'>)</span>
366
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/syscheck/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/last_scan</span><span class='tstring_end'>&quot;</span></span>
367
+ <span class='kw'>end</span></pre>
368
+ </td>
369
+ </tr>
370
+ </table>
371
+ </div>
372
+
373
+ <div class="method_details ">
374
+ <h3 class="signature " id="run_syscheck-instance_method">
375
+
376
+ #<strong>run_syscheck</strong>(agent_id) &#x21d2; <tt>Object</tt>
377
+
378
+
379
+
380
+
381
+
382
+ </h3><div class="docstring">
383
+ <div class="discussion">
384
+
385
+ <p>Runs syscheck and rootcheck on an agent (Wazuh launches both processes
386
+ simultaneously).</p>
387
+
388
+
389
+ </div>
390
+ </div>
391
+ <div class="tags">
392
+ <p class="tag_title">Parameters:</p>
393
+ <ul class="param">
394
+
395
+ <li>
396
+
397
+ <span class='name'>agent_id</span>
398
+
399
+
400
+ <span class='type'>(<tt>String</tt>)</span>
401
+
402
+
403
+
404
+ &mdash;
405
+ <div class='inline'>
406
+ <p>ID to agent</p>
407
+ </div>
408
+
409
+ </li>
410
+
411
+ </ul>
412
+
413
+
414
+ <p class="tag_title">See Also:</p>
415
+ <ul class="see">
416
+
417
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#run-syscheck-scan-in-an-agent" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#run-syscheck-scan-in-an-agent">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#run-syscheck-scan-in-an-agent</a></li>
418
+
419
+ </ul>
420
+
421
+ </div><table class="source_code">
422
+ <tr>
423
+ <td>
424
+ <pre class="lines">
425
+
426
+
427
+ 69
428
+ 70
429
+ 71</pre>
430
+ </td>
431
+ <td>
432
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/syscheck.rb', line 69</span>
433
+
434
+ <span class='kw'>def</span> <span class='id identifier rubyid_run_syscheck'>run_syscheck</span><span class='lparen'>(</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='rparen'>)</span>
435
+ <span class='id identifier rubyid_put'>put</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/syscheck/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
436
+ <span class='kw'>end</span></pre>
437
+ </td>
438
+ </tr>
439
+ </table>
440
+ </div>
441
+
442
+ <div class="method_details ">
443
+ <h3 class="signature " id="run_syscheck_all_agents-instance_method">
444
+
445
+ #<strong>run_syscheck_all_agents</strong> &#x21d2; <tt>Object</tt>
446
+
447
+
448
+
449
+
450
+
451
+ </h3><div class="docstring">
452
+ <div class="discussion">
453
+
454
+ <p>Runs syscheck and rootcheck on all agents (Wazuh launches both processes
455
+ simultaneously).</p>
456
+
457
+
458
+ </div>
459
+ </div>
460
+ <div class="tags">
461
+
462
+
463
+ <p class="tag_title">See Also:</p>
464
+ <ul class="see">
465
+
466
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#run-syscheck-scan-in-all-agents" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#run-syscheck-scan-in-all-agents">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#run-syscheck-scan-in-all-agents</a></li>
467
+
468
+ </ul>
469
+
470
+ </div><table class="source_code">
471
+ <tr>
472
+ <td>
473
+ <pre class="lines">
474
+
475
+
476
+ 60
477
+ 61
478
+ 62</pre>
479
+ </td>
480
+ <td>
481
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/syscheck.rb', line 60</span>
482
+
483
+ <span class='kw'>def</span> <span class='id identifier rubyid_run_syscheck_all_agents'>run_syscheck_all_agents</span>
484
+ <span class='id identifier rubyid_put'>put</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/syscheck</span><span class='tstring_end'>&#39;</span></span>
485
+ <span class='kw'>end</span></pre>
486
+ </td>
487
+ </tr>
488
+ </table>
489
+ </div>
490
+
491
+ <div class="method_details ">
492
+ <h3 class="signature " id="syscheck_files-instance_method">
493
+
494
+ #<strong>syscheck_files</strong>(agent_id, options) &#x21d2; <tt>Object</tt>
495
+
496
+
497
+
498
+
499
+
500
+ </h3><div class="docstring">
501
+ <div class="discussion">
502
+
503
+ <p>Returns the syscheck files of an agent.</p>
504
+
505
+
506
+ </div>
507
+ </div>
508
+ <div class="tags">
509
+ <p class="tag_title">Parameters:</p>
510
+ <ul class="param">
511
+
512
+ <li>
513
+
514
+ <span class='name'>agent_id</span>
515
+
516
+
517
+ <span class='type'>(<tt>String</tt>)</span>
518
+
519
+
520
+
521
+ &mdash;
522
+ <div class='inline'>
523
+ <p>ID to agent</p>
524
+ </div>
525
+
526
+ </li>
527
+
528
+ <li>
529
+
530
+ <span class='name'>options</span>
531
+
532
+
533
+ <span class='type'>(<tt>Hash</tt>)</span>
534
+
535
+
536
+
537
+ &mdash;
538
+ <div class='inline'>
539
+ <p>a customizable set of options</p>
540
+ </div>
541
+
542
+ </li>
543
+
544
+ </ul>
545
+
546
+
547
+
548
+
549
+
550
+
551
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
552
+ <ul class="option">
553
+
554
+ <li>
555
+ <span class="name">:offset</span>
556
+ <span class="type">(<tt>offset</tt>)</span>
557
+ <span class="default">
558
+
559
+ </span>
560
+
561
+ &mdash; <div class='inline'>
562
+ <p>First element to return in the collection.</p>
563
+ </div>
564
+
565
+ </li>
566
+
567
+ <li>
568
+ <span class="name">:limit</span>
569
+ <span class="type">(<tt>limit</tt>)</span>
570
+ <span class="default">
571
+
572
+ </span>
573
+
574
+ &mdash; <div class='inline'>
575
+ <p>Maximum number of elements to return.</p>
576
+ </div>
577
+
578
+ </li>
579
+
580
+ <li>
581
+ <span class="name">:sort</span>
582
+ <span class="type">(<tt>sort</tt>)</span>
583
+ <span class="default">
584
+
585
+ </span>
586
+
587
+ &mdash; <div class='inline'>
588
+ <p>Sorts the collection by a field or fields (separated by comma). Use +/- at
589
+ the beginning to list in ascending or descending order.</p>
590
+ </div>
591
+
592
+ </li>
593
+
594
+ <li>
595
+ <span class="name">:search</span>
596
+ <span class="type">(<tt>search</tt>)</span>
597
+ <span class="default">
598
+
599
+ </span>
600
+
601
+ &mdash; <div class='inline'>
602
+ <p>Looks for elements with the specified string.</p>
603
+ </div>
604
+
605
+ </li>
606
+
607
+ <li>
608
+ <span class="name">:file</span>
609
+ <span class="type">(<tt>file</tt>)</span>
610
+ <span class="default">
611
+
612
+ </span>
613
+
614
+ &mdash; <div class='inline'>
615
+ <p>Filters file by filename.</p>
616
+ </div>
617
+
618
+ </li>
619
+
620
+ <li>
621
+ <span class="name">:type</span>
622
+ <span class="type">(<tt>type</tt>)</span>
623
+ <span class="default">
624
+
625
+ </span>
626
+
627
+ &mdash; <div class='inline'>
628
+ <p>Selects type of file. Allowed values: file, registry</p>
629
+ </div>
630
+
631
+ </li>
632
+
633
+ <li>
634
+ <span class="name">:summary</span>
635
+ <span class="type">(<tt><span class='object_link'><a href="Summary.html#summary-instance_method" title="Wazuh::Api::Endpoints::Summary#summary (method)">summary</a></span></tt>)</span>
636
+ <span class="default">
637
+
638
+ </span>
639
+
640
+ &mdash; <div class='inline'>
641
+ <p>Returns a summary grouping by filename. Allowed values: yes, no</p>
642
+ </div>
643
+
644
+ </li>
645
+
646
+ <li>
647
+ <span class="name">:select</span>
648
+ <span class="type">(<tt>select</tt>)</span>
649
+ <span class="default">
650
+
651
+ </span>
652
+
653
+ &mdash; <div class='inline'>
654
+ <p>List of selected fields separated by commas.</p>
655
+ </div>
656
+
657
+ </li>
658
+
659
+ <li>
660
+ <span class="name">:md5</span>
661
+ <span class="type">(<tt>md5</tt>)</span>
662
+ <span class="default">
663
+
664
+ </span>
665
+
666
+ &mdash; <div class='inline'>
667
+ <p>Returns the files with the specified md5 hash.</p>
668
+ </div>
669
+
670
+ </li>
671
+
672
+ <li>
673
+ <span class="name">:sha1</span>
674
+ <span class="type">(<tt>sha1</tt>)</span>
675
+ <span class="default">
676
+
677
+ </span>
678
+
679
+ &mdash; <div class='inline'>
680
+ <p>Returns the files with the specified sha1 hash.</p>
681
+ </div>
682
+
683
+ </li>
684
+
685
+ <li>
686
+ <span class="name">:sha256</span>
687
+ <span class="type">(<tt>sha256</tt>)</span>
688
+ <span class="default">
689
+
690
+ </span>
691
+
692
+ &mdash; <div class='inline'>
693
+ <p>Returns the files with the specified sha256 hash.</p>
694
+ </div>
695
+
696
+ </li>
697
+
698
+ <li>
699
+ <span class="name">:hash</span>
700
+ <span class="type">(<tt>hash</tt>)</span>
701
+ <span class="default">
702
+
703
+ </span>
704
+
705
+ &mdash; <div class='inline'>
706
+ <p>Returns the files with the specified hash (md5, sha1 or sha256).</p>
707
+ </div>
708
+
709
+ </li>
710
+
711
+ </ul>
712
+
713
+
714
+
715
+ <p class="tag_title">See Also:</p>
716
+ <ul class="see">
717
+
718
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-syscheck-files" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-syscheck-files">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-syscheck-files</a></li>
719
+
720
+ </ul>
721
+
722
+ </div><table class="source_code">
723
+ <tr>
724
+ <td>
725
+ <pre class="lines">
726
+
727
+
728
+ 53
729
+ 54
730
+ 55</pre>
731
+ </td>
732
+ <td>
733
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/syscheck.rb', line 53</span>
734
+
735
+ <span class='kw'>def</span> <span class='id identifier rubyid_syscheck_files'>syscheck_files</span><span class='lparen'>(</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
736
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/syscheck/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
737
+ <span class='kw'>end</span></pre>
738
+ </td>
739
+ </tr>
740
+ </table>
741
+ </div>
742
+
743
+ </div>
744
+
745
+ </div>
746
+
747
+ <div id="footer">
748
+ Generated on Sat Jan 25 00:19:40 2020 by
749
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
750
+ 0.9.16 (ruby-2.5.1).
751
+ </div>
752
+
753
+ </div>
754
+ </body>
755
+ </html>