wazuh-ruby-client 0.1.0

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