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/Decoders.html ADDED
@@ -0,0 +1,860 @@
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::Decoders
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::Decoders";
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 (D)</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">Decoders</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::Decoders
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/decoders.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="#all_decoders-instance_method" title="#all_decoders (instance method)">#<strong>all_decoders</strong>(options = {}) &#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>Get all decoders Returns all decoders included in ossec.conf.</p>
125
+ </div></span>
126
+
127
+ </li>
128
+
129
+
130
+ <li class="public ">
131
+ <span class="summary_signature">
132
+
133
+ <a href="#all_decoders_files-instance_method" title="#all_decoders_files (instance method)">#<strong>all_decoders_files</strong>(options = {}) &#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>Get all decoders files Returns all decoders files included in ossec.conf.</p>
149
+ </div></span>
150
+
151
+ </li>
152
+
153
+
154
+ <li class="public ">
155
+ <span class="summary_signature">
156
+
157
+ <a href="#all_parent_decoders-instance_method" title="#all_parent_decoders (instance method)">#<strong>all_parent_decoders</strong>(options = {}) &#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>Get all parent decoders Returns all parent decoders included in ossec.conf.</p>
173
+ </div></span>
174
+
175
+ </li>
176
+
177
+
178
+ <li class="public ">
179
+ <span class="summary_signature">
180
+
181
+ <a href="#decoders_by_name-instance_method" title="#decoders_by_name (instance method)">#<strong>decoders_by_name</strong>(decoder_name, options = {}) &#x21d2; Object </a>
182
+
183
+
184
+
185
+ </span>
186
+
187
+
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+ <span class="summary_desc"><div class='inline'>
196
+ <p>Get decoders by name Returns the decoders with the specified name.</p>
197
+ </div></span>
198
+
199
+ </li>
200
+
201
+
202
+ </ul>
203
+
204
+
205
+
206
+
207
+ <div id="instance_method_details" class="method_details_list">
208
+ <h2>Instance Method Details</h2>
209
+
210
+
211
+ <div class="method_details first">
212
+ <h3 class="signature first" id="all_decoders-instance_method">
213
+
214
+ #<strong>all_decoders</strong>(options = {}) &#x21d2; <tt>Object</tt>
215
+
216
+
217
+
218
+
219
+
220
+ </h3><div class="docstring">
221
+ <div class="discussion">
222
+
223
+ <p>Get all decoders Returns all decoders included in ossec.conf.</p>
224
+
225
+
226
+ </div>
227
+ </div>
228
+ <div class="tags">
229
+ <p class="tag_title">Parameters:</p>
230
+ <ul class="param">
231
+
232
+ <li>
233
+
234
+ <span class='name'>options</span>
235
+
236
+
237
+ <span class='type'>(<tt>Hash</tt>)</span>
238
+
239
+
240
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
241
+
242
+
243
+ &mdash;
244
+ <div class='inline'>
245
+ <p>a customizable set of options</p>
246
+ </div>
247
+
248
+ </li>
249
+
250
+ </ul>
251
+
252
+
253
+
254
+
255
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
256
+ <ul class="option">
257
+
258
+ <li>
259
+ <span class="name">:offset</span>
260
+ <span class="type">(<tt>offset</tt>)</span>
261
+ <span class="default">
262
+
263
+ </span>
264
+
265
+ &mdash; <div class='inline'>
266
+ <p>First element to return in the collection.</p>
267
+ </div>
268
+
269
+ </li>
270
+
271
+ <li>
272
+ <span class="name">:limit</span>
273
+ <span class="type">(<tt>limit</tt>)</span>
274
+ <span class="default">
275
+
276
+ </span>
277
+
278
+ &mdash; <div class='inline'>
279
+ <p>Maximum number of elements to return.</p>
280
+ </div>
281
+
282
+ </li>
283
+
284
+ <li>
285
+ <span class="name">:sort</span>
286
+ <span class="type">(<tt>sort</tt>)</span>
287
+ <span class="default">
288
+
289
+ </span>
290
+
291
+ &mdash; <div class='inline'>
292
+ <p>Sorts the collection by a field or fields (separated by comma). Use +/- at
293
+ the beginning to list in ascending or descending order.</p>
294
+ </div>
295
+
296
+ </li>
297
+
298
+ <li>
299
+ <span class="name">:search</span>
300
+ <span class="type">(<tt>search</tt>)</span>
301
+ <span class="default">
302
+
303
+ </span>
304
+
305
+ &mdash; <div class='inline'>
306
+ <p>Looks for elements with the specified string.</p>
307
+ </div>
308
+
309
+ </li>
310
+
311
+ <li>
312
+ <span class="name">:file</span>
313
+ <span class="type">(<tt>file</tt>)</span>
314
+ <span class="default">
315
+
316
+ </span>
317
+
318
+ &mdash; <div class='inline'>
319
+ <p>Filters by filename.</p>
320
+ </div>
321
+
322
+ </li>
323
+
324
+ <li>
325
+ <span class="name">:path</span>
326
+ <span class="type">(<tt>path</tt>)</span>
327
+ <span class="default">
328
+
329
+ </span>
330
+
331
+ &mdash; <div class='inline'>
332
+ <p>Filters by path.</p>
333
+ </div>
334
+
335
+ </li>
336
+
337
+ <li>
338
+ <span class="name">:status</span>
339
+ <span class="type">(<tt>status</tt>)</span>
340
+ <span class="default">
341
+
342
+ </span>
343
+
344
+ &mdash; <div class='inline'>
345
+ <p>Filters the decoders by status. Allowed values: enabled, disabled, all</p>
346
+ </div>
347
+
348
+ </li>
349
+
350
+ </ul>
351
+
352
+
353
+
354
+ <p class="tag_title">See Also:</p>
355
+ <ul class="see">
356
+
357
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-all-decoders" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-all-decoders">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-all-decoders</a></li>
358
+
359
+ </ul>
360
+
361
+ </div><table class="source_code">
362
+ <tr>
363
+ <td>
364
+ <pre class="lines">
365
+
366
+
367
+ 25
368
+ 26
369
+ 27</pre>
370
+ </td>
371
+ <td>
372
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/decoders.rb', line 25</span>
373
+
374
+ <span class='kw'>def</span> <span class='id identifier rubyid_all_decoders'>all_decoders</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
375
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/decoders</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
376
+ <span class='kw'>end</span></pre>
377
+ </td>
378
+ </tr>
379
+ </table>
380
+ </div>
381
+
382
+ <div class="method_details ">
383
+ <h3 class="signature " id="all_decoders_files-instance_method">
384
+
385
+ #<strong>all_decoders_files</strong>(options = {}) &#x21d2; <tt>Object</tt>
386
+
387
+
388
+
389
+
390
+
391
+ </h3><div class="docstring">
392
+ <div class="discussion">
393
+
394
+ <p>Get all decoders files Returns all decoders files included in ossec.conf.</p>
395
+
396
+
397
+ </div>
398
+ </div>
399
+ <div class="tags">
400
+ <p class="tag_title">Parameters:</p>
401
+ <ul class="param">
402
+
403
+ <li>
404
+
405
+ <span class='name'>options</span>
406
+
407
+
408
+ <span class='type'>(<tt>Hash</tt>)</span>
409
+
410
+
411
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
412
+
413
+
414
+ &mdash;
415
+ <div class='inline'>
416
+ <p>a customizable set of options</p>
417
+ </div>
418
+
419
+ </li>
420
+
421
+ </ul>
422
+
423
+
424
+
425
+
426
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
427
+ <ul class="option">
428
+
429
+ <li>
430
+ <span class="name">:offset</span>
431
+ <span class="type">(<tt>offset</tt>)</span>
432
+ <span class="default">
433
+
434
+ </span>
435
+
436
+ &mdash; <div class='inline'>
437
+ <p>First element to return in the collection.</p>
438
+ </div>
439
+
440
+ </li>
441
+
442
+ <li>
443
+ <span class="name">:limit</span>
444
+ <span class="type">(<tt>limit</tt>)</span>
445
+ <span class="default">
446
+
447
+ </span>
448
+
449
+ &mdash; <div class='inline'>
450
+ <p>Maximum number of elements to return.</p>
451
+ </div>
452
+
453
+ </li>
454
+
455
+ <li>
456
+ <span class="name">:sort</span>
457
+ <span class="type">(<tt>sort</tt>)</span>
458
+ <span class="default">
459
+
460
+ </span>
461
+
462
+ &mdash; <div class='inline'>
463
+ <p>Sorts the collection by a field or fields (separated by comma). Use +/- at
464
+ the beginning to list in ascending or descending order.</p>
465
+ </div>
466
+
467
+ </li>
468
+
469
+ <li>
470
+ <span class="name">:search</span>
471
+ <span class="type">(<tt>search</tt>)</span>
472
+ <span class="default">
473
+
474
+ </span>
475
+
476
+ &mdash; <div class='inline'>
477
+ <p>Looks for elements with the specified string.</p>
478
+ </div>
479
+
480
+ </li>
481
+
482
+ <li>
483
+ <span class="name">:file</span>
484
+ <span class="type">(<tt>file</tt>)</span>
485
+ <span class="default">
486
+
487
+ </span>
488
+
489
+ &mdash; <div class='inline'>
490
+ <p>Filters by filename.</p>
491
+ </div>
492
+
493
+ </li>
494
+
495
+ <li>
496
+ <span class="name">:path</span>
497
+ <span class="type">(<tt>path</tt>)</span>
498
+ <span class="default">
499
+
500
+ </span>
501
+
502
+ &mdash; <div class='inline'>
503
+ <p>Filters by path.</p>
504
+ </div>
505
+
506
+ </li>
507
+
508
+ <li>
509
+ <span class="name">:status</span>
510
+ <span class="type">(<tt>status</tt>)</span>
511
+ <span class="default">
512
+
513
+ </span>
514
+
515
+ &mdash; <div class='inline'>
516
+ <p>Filters the decoders by status. Allowed values: enabled, disabled, all</p>
517
+ </div>
518
+
519
+ </li>
520
+
521
+ <li>
522
+ <span class="name">:download</span>
523
+ <span class="type">(<tt>download</tt>)</span>
524
+ <span class="default">
525
+
526
+ </span>
527
+
528
+ &mdash; <div class='inline'>
529
+ <p>Name of the decoder file to download.</p>
530
+ </div>
531
+
532
+ </li>
533
+
534
+ </ul>
535
+
536
+
537
+
538
+ <p class="tag_title">See Also:</p>
539
+ <ul class="see">
540
+
541
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-all-decoders-files" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-all-decoders-files">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-all-decoders-files</a></li>
542
+
543
+ </ul>
544
+
545
+ </div><table class="source_code">
546
+ <tr>
547
+ <td>
548
+ <pre class="lines">
549
+
550
+
551
+ 51
552
+ 52
553
+ 53</pre>
554
+ </td>
555
+ <td>
556
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/decoders.rb', line 51</span>
557
+
558
+ <span class='kw'>def</span> <span class='id identifier rubyid_all_decoders_files'>all_decoders_files</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
559
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/decoders/files</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
560
+ <span class='kw'>end</span></pre>
561
+ </td>
562
+ </tr>
563
+ </table>
564
+ </div>
565
+
566
+ <div class="method_details ">
567
+ <h3 class="signature " id="all_parent_decoders-instance_method">
568
+
569
+ #<strong>all_parent_decoders</strong>(options = {}) &#x21d2; <tt>Object</tt>
570
+
571
+
572
+
573
+
574
+
575
+ </h3><div class="docstring">
576
+ <div class="discussion">
577
+
578
+ <p>Get all parent decoders Returns all parent decoders included in ossec.conf.</p>
579
+
580
+
581
+ </div>
582
+ </div>
583
+ <div class="tags">
584
+ <p class="tag_title">Parameters:</p>
585
+ <ul class="param">
586
+
587
+ <li>
588
+
589
+ <span class='name'>options</span>
590
+
591
+
592
+ <span class='type'>(<tt>Hash</tt>)</span>
593
+
594
+
595
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
596
+
597
+
598
+ &mdash;
599
+ <div class='inline'>
600
+ <p>a customizable set of options</p>
601
+ </div>
602
+
603
+ </li>
604
+
605
+ </ul>
606
+
607
+
608
+
609
+
610
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
611
+ <ul class="option">
612
+
613
+ <li>
614
+ <span class="name">:offset</span>
615
+ <span class="type">(<tt>offset</tt>)</span>
616
+ <span class="default">
617
+
618
+ </span>
619
+
620
+ &mdash; <div class='inline'>
621
+ <p>First element to return in the collection.</p>
622
+ </div>
623
+
624
+ </li>
625
+
626
+ <li>
627
+ <span class="name">:limit</span>
628
+ <span class="type">(<tt>limit</tt>)</span>
629
+ <span class="default">
630
+
631
+ </span>
632
+
633
+ &mdash; <div class='inline'>
634
+ <p>Maximum number of elements to return.</p>
635
+ </div>
636
+
637
+ </li>
638
+
639
+ <li>
640
+ <span class="name">:sort</span>
641
+ <span class="type">(<tt>sort</tt>)</span>
642
+ <span class="default">
643
+
644
+ </span>
645
+
646
+ &mdash; <div class='inline'>
647
+ <p>Sorts the collection by a field or fields (separated by comma). Use +/- at
648
+ the beginning to list in ascending or descending order.</p>
649
+ </div>
650
+
651
+ </li>
652
+
653
+ <li>
654
+ <span class="name">:search</span>
655
+ <span class="type">(<tt>search</tt>)</span>
656
+ <span class="default">
657
+
658
+ </span>
659
+
660
+ &mdash; <div class='inline'>
661
+ <p>Looks for elements with the specified string.</p>
662
+ </div>
663
+
664
+ </li>
665
+
666
+ </ul>
667
+
668
+
669
+
670
+ <p class="tag_title">See Also:</p>
671
+ <ul class="see">
672
+
673
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-all-parent-decoders" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-all-parent-decoders">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-all-parent-decoders</a></li>
674
+
675
+ </ul>
676
+
677
+ </div><table class="source_code">
678
+ <tr>
679
+ <td>
680
+ <pre class="lines">
681
+
682
+
683
+ 67
684
+ 68
685
+ 69</pre>
686
+ </td>
687
+ <td>
688
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/decoders.rb', line 67</span>
689
+
690
+ <span class='kw'>def</span> <span class='id identifier rubyid_all_parent_decoders'>all_parent_decoders</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
691
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/decoders/parents</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span>
692
+ <span class='kw'>end</span></pre>
693
+ </td>
694
+ </tr>
695
+ </table>
696
+ </div>
697
+
698
+ <div class="method_details ">
699
+ <h3 class="signature " id="decoders_by_name-instance_method">
700
+
701
+ #<strong>decoders_by_name</strong>(decoder_name, options = {}) &#x21d2; <tt>Object</tt>
702
+
703
+
704
+
705
+
706
+
707
+ </h3><div class="docstring">
708
+ <div class="discussion">
709
+
710
+ <p>Get decoders by name Returns the decoders with the specified name.</p>
711
+
712
+
713
+ </div>
714
+ </div>
715
+ <div class="tags">
716
+ <p class="tag_title">Parameters:</p>
717
+ <ul class="param">
718
+
719
+ <li>
720
+
721
+ <span class='name'>decoder_name</span>
722
+
723
+
724
+ <span class='type'>(<tt>String</tt>)</span>
725
+
726
+
727
+
728
+ &mdash;
729
+ <div class='inline'>
730
+ <p>Decoder name</p>
731
+ </div>
732
+
733
+ </li>
734
+
735
+ <li>
736
+
737
+ <span class='name'>options</span>
738
+
739
+
740
+ <span class='type'>(<tt>Hash</tt>)</span>
741
+
742
+
743
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
744
+
745
+
746
+ &mdash;
747
+ <div class='inline'>
748
+ <p>a customizable set of options</p>
749
+ </div>
750
+
751
+ </li>
752
+
753
+ </ul>
754
+
755
+
756
+
757
+
758
+
759
+
760
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
761
+ <ul class="option">
762
+
763
+ <li>
764
+ <span class="name">:offset</span>
765
+ <span class="type">(<tt>offset</tt>)</span>
766
+ <span class="default">
767
+
768
+ </span>
769
+
770
+ &mdash; <div class='inline'>
771
+ <p>First element to return in the collection.</p>
772
+ </div>
773
+
774
+ </li>
775
+
776
+ <li>
777
+ <span class="name">:limit</span>
778
+ <span class="type">(<tt>limit</tt>)</span>
779
+ <span class="default">
780
+
781
+ </span>
782
+
783
+ &mdash; <div class='inline'>
784
+ <p>Maximum number of elements to return.</p>
785
+ </div>
786
+
787
+ </li>
788
+
789
+ <li>
790
+ <span class="name">:sort</span>
791
+ <span class="type">(<tt>sort</tt>)</span>
792
+ <span class="default">
793
+
794
+ </span>
795
+
796
+ &mdash; <div class='inline'>
797
+ <p>Sorts the collection by a field or fields (separated by comma). Use +/- at
798
+ the beginning to list in ascending or descending order.</p>
799
+ </div>
800
+
801
+ </li>
802
+
803
+ <li>
804
+ <span class="name">:search</span>
805
+ <span class="type">(<tt>search</tt>)</span>
806
+ <span class="default">
807
+
808
+ </span>
809
+
810
+ &mdash; <div class='inline'>
811
+ <p>Looks for elements with the specified string.</p>
812
+ </div>
813
+
814
+ </li>
815
+
816
+ </ul>
817
+
818
+
819
+
820
+ <p class="tag_title">See Also:</p>
821
+ <ul class="see">
822
+
823
+ <li><a href="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-decoders-by-name" target="_parent" title="https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-decoders-by-name">https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-decoders-by-name</a></li>
824
+
825
+ </ul>
826
+
827
+ </div><table class="source_code">
828
+ <tr>
829
+ <td>
830
+ <pre class="lines">
831
+
832
+
833
+ 85
834
+ 86
835
+ 87</pre>
836
+ </td>
837
+ <td>
838
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/decoders.rb', line 85</span>
839
+
840
+ <span class='kw'>def</span> <span class='id identifier rubyid_decoders_by_name'>decoders_by_name</span><span class='lparen'>(</span><span class='id identifier rubyid_decoder_name'>decoder_name</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
841
+ <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/decoders/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_decoder_name'>decoder_name</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>
842
+ <span class='kw'>end</span></pre>
843
+ </td>
844
+ </tr>
845
+ </table>
846
+ </div>
847
+
848
+ </div>
849
+
850
+ </div>
851
+
852
+ <div id="footer">
853
+ Generated on Sat Jan 25 00:19:40 2020 by
854
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
855
+ 0.9.16 (ruby-2.5.1).
856
+ </div>
857
+
858
+ </div>
859
+ </body>
860
+ </html>