wazuh-ruby-client 0.3.0 → 0.3.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (68) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/codeql-analysis.yml +70 -0
  3. data/CHANGELOG.md +25 -0
  4. data/README.md +18 -1
  5. data/Rakefile +4 -0
  6. data/docs/Wazuh/Api/Endpoints/ActiveResponse.html +10 -13
  7. data/docs/Wazuh/Api/Endpoints/Agents.html +483 -204
  8. data/docs/Wazuh/Api/Endpoints/Cache.html +7 -7
  9. data/docs/Wazuh/Api/Endpoints/Ciscat.html +10 -13
  10. data/docs/Wazuh/Api/Endpoints/Cluster.html +52 -58
  11. data/docs/Wazuh/Api/Endpoints/Decoders.html +27 -39
  12. data/docs/Wazuh/Api/Endpoints/Experimental.html +63 -96
  13. data/docs/Wazuh/Api/Endpoints/Lists.html +15 -21
  14. data/docs/Wazuh/Api/Endpoints/Manager.html +44 -62
  15. data/docs/Wazuh/Api/Endpoints/Rootcheck.html +36 -52
  16. data/docs/Wazuh/Api/Endpoints/Rules.html +49 -68
  17. data/docs/Wazuh/Api/Endpoints/SecurityConfigurationAssessment.html +20 -31
  18. data/docs/Wazuh/Api/Endpoints/Summary.html +7 -7
  19. data/docs/Wazuh/Api/Endpoints/Syscheck.html +26 -33
  20. data/docs/Wazuh/Api/Endpoints/Syscollector.html +43 -61
  21. data/docs/Wazuh/Api/Endpoints/V4/ActiveResponse.html +198 -0
  22. data/docs/Wazuh/Api/Endpoints/V4/Agents.html +1079 -0
  23. data/docs/Wazuh/Api/Endpoints/V4/Cache.html +195 -0
  24. data/docs/Wazuh/Api/Endpoints/V4/Ciscat.html +126 -0
  25. data/docs/Wazuh/Api/Endpoints/V4/Cluster.html +126 -0
  26. data/docs/Wazuh/Api/Endpoints/V4/Decoders.html +126 -0
  27. data/docs/Wazuh/Api/Endpoints/V4/Experimental.html +126 -0
  28. data/docs/Wazuh/Api/Endpoints/V4/Lists.html +126 -0
  29. data/docs/Wazuh/Api/Endpoints/V4/Manager.html +126 -0
  30. data/docs/Wazuh/Api/Endpoints/V4/Rootcheck.html +126 -0
  31. data/docs/Wazuh/Api/Endpoints/V4/Rules.html +126 -0
  32. data/docs/Wazuh/Api/Endpoints/V4/SecurityConfigurationAssessment.html +126 -0
  33. data/docs/Wazuh/Api/Endpoints/V4/Summary.html +126 -0
  34. data/docs/Wazuh/Api/Endpoints/V4/Syscheck.html +126 -0
  35. data/docs/Wazuh/Api/Endpoints/V4/Syscollector.html +126 -0
  36. data/docs/Wazuh/Api/Endpoints/V4/Vulnerabilities.html +399 -0
  37. data/docs/Wazuh/Api/Endpoints/V4.html +403 -0
  38. data/docs/Wazuh/Api/Endpoints.html +9 -14
  39. data/docs/Wazuh/Api/Errors/WazuhError.html +9 -9
  40. data/docs/Wazuh/Api/Errors.html +6 -6
  41. data/docs/Wazuh/Api.html +7 -7
  42. data/docs/Wazuh/Client.html +35 -190
  43. data/docs/Wazuh/Config.html +20 -11
  44. data/docs/Wazuh/Logger.html +6 -6
  45. data/docs/Wazuh/Sawyer/Connection/Token.html +208 -0
  46. data/docs/Wazuh/Sawyer/Connection.html +19 -7
  47. data/docs/Wazuh/Sawyer/Request.html +78 -6
  48. data/docs/Wazuh/Sawyer.html +8 -8
  49. data/docs/Wazuh.html +16 -16
  50. data/docs/WazuhRubyClient.html +7 -7
  51. data/docs/_index.html +149 -7
  52. data/docs/class_list.html +3 -3
  53. data/docs/css/style.css +2 -2
  54. data/docs/file.README.html +39 -18
  55. data/docs/file_list.html +2 -2
  56. data/docs/frames.html +2 -2
  57. data/docs/index.html +39 -18
  58. data/docs/js/app.js +25 -3
  59. data/docs/method_list.html +269 -69
  60. data/docs/top-level-namespace.html +6 -6
  61. data/lib/wazuh/api/endpoints/v4/vulnerabilities.rb +47 -0
  62. data/lib/wazuh/api/endpoints/v4.rb +2 -1
  63. data/lib/wazuh/sawyer/connection.rb +2 -2
  64. data/lib/wazuh/sawyer/request.rb +5 -2
  65. data/lib/wazuh/sawyer/token.rb +1 -1
  66. data/lib/wazuh/version.rb +1 -1
  67. data/lib/wazuh-ruby-client/version.rb +1 -1
  68. metadata +25 -5
@@ -6,15 +6,15 @@
6
6
  <title>
7
7
  Module: Wazuh::Api::Endpoints::Rules
8
8
 
9
- &mdash; Documentation by YARD 0.9.16
9
+ &mdash; Documentation by YARD 0.9.25
10
10
 
11
11
  </title>
12
12
 
13
- <link rel="stylesheet" href="../../../css/style.css" type="text/css" charset="utf-8" />
13
+ <link rel="stylesheet" href="../../../css/style.css" type="text/css" />
14
14
 
15
- <link rel="stylesheet" href="../../../css/common.css" type="text/css" charset="utf-8" />
15
+ <link rel="stylesheet" href="../../../css/common.css" type="text/css" />
16
16
 
17
- <script type="text/javascript" charset="utf-8">
17
+ <script type="text/javascript">
18
18
  pathId = "Wazuh::Api::Endpoints::Rules";
19
19
  relpath = '../../../';
20
20
  </script>
@@ -76,7 +76,7 @@
76
76
 
77
77
  <dl>
78
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>
79
+ <dd><span class='object_link'><a href="../Endpoints.html" title="Wazuh::Api::Endpoints (module)">Wazuh::Api::Endpoints</a></span>, <span class='object_link'><a href="V4/Rules.html" title="Wazuh::Api::Endpoints::V4::Rules (module)">V4::Rules</a></span></dd>
80
80
  </dl>
81
81
 
82
82
 
@@ -363,15 +363,13 @@
363
363
 
364
364
  9
365
365
  10
366
- 11
367
- 12</pre>
366
+ 11</pre>
368
367
  </td>
369
368
  <td>
370
369
  <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/rules.rb', line 9</span>
371
370
 
372
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>
373
- <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <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>
374
- <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_items'>items</span>
372
+ <span class='id identifier rubyid_offset_request'>offset_request</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>get</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</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><span class='rparen'>)</span>
375
373
  <span class='kw'>end</span></pre>
376
374
  </td>
377
375
  </tr>
@@ -411,17 +409,15 @@
411
409
  <pre class="lines">
412
410
 
413
411
 
414
- 25
415
- 26
416
- 27
417
- 28</pre>
412
+ 23
413
+ 24
414
+ 25</pre>
418
415
  </td>
419
416
  <td>
420
- <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/rules.rb', line 25</span>
417
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/rules.rb', line 23</span>
421
418
 
422
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>
423
- <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <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>
424
- <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_items'>items</span>
420
+ <span class='id identifier rubyid_offset_request'>offset_request</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>get</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</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><span class='rparen'>)</span>
425
421
  <span class='kw'>end</span></pre>
426
422
  </td>
427
423
  </tr>
@@ -461,17 +457,15 @@
461
457
  <pre class="lines">
462
458
 
463
459
 
464
- 33
465
- 34
466
- 35
467
- 36</pre>
460
+ 30
461
+ 31
462
+ 32</pre>
468
463
  </td>
469
464
  <td>
470
- <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/rules.rb', line 33</span>
465
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/rules.rb', line 30</span>
471
466
 
472
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>
473
- <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <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>
474
- <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_items'>items</span>
468
+ <span class='id identifier rubyid_offset_request'>offset_request</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>get</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</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><span class='rparen'>)</span>
475
469
  <span class='kw'>end</span></pre>
476
470
  </td>
477
471
  </tr>
@@ -511,17 +505,15 @@
511
505
  <pre class="lines">
512
506
 
513
507
 
514
- 49
515
- 50
516
- 51
517
- 52</pre>
508
+ 44
509
+ 45
510
+ 46</pre>
518
511
  </td>
519
512
  <td>
520
- <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/rules.rb', line 49</span>
513
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/rules.rb', line 44</span>
521
514
 
522
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>
523
- <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <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>
524
- <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_items'>items</span>
516
+ <span class='id identifier rubyid_offset_request'>offset_request</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>get</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</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><span class='rparen'>)</span>
525
517
  <span class='kw'>end</span></pre>
526
518
  </td>
527
519
  </tr>
@@ -561,17 +553,15 @@
561
553
  <pre class="lines">
562
554
 
563
555
 
564
- 57
565
- 58
566
- 59
567
- 60</pre>
556
+ 51
557
+ 52
558
+ 53</pre>
568
559
  </td>
569
560
  <td>
570
- <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/rules.rb', line 57</span>
561
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/rules.rb', line 51</span>
571
562
 
572
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>
573
- <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <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>
574
- <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_items'>items</span>
564
+ <span class='id identifier rubyid_offset_request'>offset_request</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>get</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</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><span class='rparen'>)</span>
575
565
  <span class='kw'>end</span></pre>
576
566
  </td>
577
567
  </tr>
@@ -611,17 +601,15 @@
611
601
  <pre class="lines">
612
602
 
613
603
 
614
- 65
615
- 66
616
- 67
617
- 68</pre>
604
+ 58
605
+ 59
606
+ 60</pre>
618
607
  </td>
619
608
  <td>
620
- <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/rules.rb', line 65</span>
609
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/rules.rb', line 58</span>
621
610
 
622
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>
623
- <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <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>
624
- <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_items'>items</span>
612
+ <span class='id identifier rubyid_offset_request'>offset_request</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>get</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</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><span class='rparen'>)</span>
625
613
  <span class='kw'>end</span></pre>
626
614
  </td>
627
615
  </tr>
@@ -722,8 +710,7 @@
722
710
  </span>
723
711
 
724
712
  &mdash; <div class='inline'>
725
- <p>Sorts the collection by a field or fields (separated by comma). Use +/- at
726
- the beginning to list in ascending or descending order.</p>
713
+ <p>Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.</p>
727
714
  </div>
728
715
 
729
716
  </li>
@@ -758,17 +745,15 @@ the beginning to list in ascending or descending order.</p>
758
745
  <pre class="lines">
759
746
 
760
747
 
761
- 82
762
- 83
763
- 84
764
- 85</pre>
748
+ 74
749
+ 75
750
+ 76</pre>
765
751
  </td>
766
752
  <td>
767
- <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/rules.rb', line 82</span>
753
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/rules.rb', line 74</span>
768
754
 
769
755
  <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>
770
- <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <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>
771
- <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_items'>items</span>
756
+ <span class='id identifier rubyid_offset_request'>offset_request</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>get</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</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><span class='rparen'>)</span>
772
757
  <span class='kw'>end</span></pre>
773
758
  </td>
774
759
  </tr>
@@ -808,17 +793,15 @@ the beginning to list in ascending or descending order.</p>
808
793
  <pre class="lines">
809
794
 
810
795
 
796
+ 16
811
797
  17
812
- 18
813
- 19
814
- 20</pre>
798
+ 18</pre>
815
799
  </td>
816
800
  <td>
817
- <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/rules.rb', line 17</span>
801
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/rules.rb', line 16</span>
818
802
 
819
803
  <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>
820
- <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <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>
821
- <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_items'>items</span>
804
+ <span class='id identifier rubyid_offset_request'>offset_request</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>get</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</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><span class='rparen'>)</span>
822
805
  <span class='kw'>end</span></pre>
823
806
  </td>
824
807
  </tr>
@@ -858,17 +841,15 @@ the beginning to list in ascending or descending order.</p>
858
841
  <pre class="lines">
859
842
 
860
843
 
861
- 41
862
- 42
863
- 43
864
- 44</pre>
844
+ 37
845
+ 38
846
+ 39</pre>
865
847
  </td>
866
848
  <td>
867
- <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/rules.rb', line 41</span>
849
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/rules.rb', line 37</span>
868
850
 
869
851
  <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>
870
- <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <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>
871
- <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_items'>items</span>
852
+ <span class='id identifier rubyid_offset_request'>offset_request</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>get</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</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><span class='rparen'>)</span>
872
853
  <span class='kw'>end</span></pre>
873
854
  </td>
874
855
  </tr>
@@ -880,9 +861,9 @@ the beginning to list in ascending or descending order.</p>
880
861
  </div>
881
862
 
882
863
  <div id="footer">
883
- Generated on Tue Feb 18 20:12:27 2020 by
864
+ Generated on Thu Feb 3 21:40:17 2022 by
884
865
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
885
- 0.9.16 (ruby-2.5.1).
866
+ 0.9.25 (ruby-2.6.3).
886
867
  </div>
887
868
 
888
869
  </div>
@@ -6,15 +6,15 @@
6
6
  <title>
7
7
  Module: Wazuh::Api::Endpoints::SecurityConfigurationAssessment
8
8
 
9
- &mdash; Documentation by YARD 0.9.16
9
+ &mdash; Documentation by YARD 0.9.25
10
10
 
11
11
  </title>
12
12
 
13
- <link rel="stylesheet" href="../../../css/style.css" type="text/css" charset="utf-8" />
13
+ <link rel="stylesheet" href="../../../css/style.css" type="text/css" />
14
14
 
15
- <link rel="stylesheet" href="../../../css/common.css" type="text/css" charset="utf-8" />
15
+ <link rel="stylesheet" href="../../../css/common.css" type="text/css" />
16
16
 
17
- <script type="text/javascript" charset="utf-8">
17
+ <script type="text/javascript">
18
18
  pathId = "Wazuh::Api::Endpoints::SecurityConfigurationAssessment";
19
19
  relpath = '../../../';
20
20
  </script>
@@ -76,7 +76,7 @@
76
76
 
77
77
  <dl>
78
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>
79
+ <dd><span class='object_link'><a href="../Endpoints.html" title="Wazuh::Api::Endpoints (module)">Wazuh::Api::Endpoints</a></span>, <span class='object_link'><a href="V4/SecurityConfigurationAssessment.html" title="Wazuh::Api::Endpoints::V4::SecurityConfigurationAssessment (module)">V4::SecurityConfigurationAssessment</a></span></dd>
80
80
  </dl>
81
81
 
82
82
 
@@ -121,8 +121,7 @@
121
121
 
122
122
 
123
123
  <span class="summary_desc"><div class='inline'>
124
- <p>Get security configuration assessment (SCA) checks database Returns the sca
125
- checks of an agent.</p>
124
+ <p>Get security configuration assessment (SCA) checks database Returns the sca checks of an agent.</p>
126
125
  </div></span>
127
126
 
128
127
  </li>
@@ -146,8 +145,7 @@ checks of an agent.</p>
146
145
 
147
146
 
148
147
  <span class="summary_desc"><div class='inline'>
149
- <p>Get security configuration assessment (SCA) database Returns the sca
150
- database of an agent.</p>
148
+ <p>Get security configuration assessment (SCA) database Returns the sca database of an agent.</p>
151
149
  </div></span>
152
150
 
153
151
  </li>
@@ -174,8 +172,7 @@ database of an agent.</p>
174
172
  </h3><div class="docstring">
175
173
  <div class="discussion">
176
174
 
177
- <p>Get security configuration assessment (SCA) checks database Returns the sca
178
- checks of an agent.</p>
175
+ <p>Get security configuration assessment (SCA) checks database Returns the sca checks of an agent.</p>
179
176
 
180
177
 
181
178
  </div>
@@ -410,8 +407,7 @@ checks of an agent.</p>
410
407
  </span>
411
408
 
412
409
  &mdash; <div class='inline'>
413
- <p>Sorts the collection by a field or fields (separated by comma). Use +/- at
414
- the beginning to list in ascending or descending order.</p>
410
+ <p>Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.</p>
415
411
  </div>
416
412
 
417
413
  </li>
@@ -448,15 +444,13 @@ the beginning to list in ascending or descending order.</p>
448
444
 
449
445
  41
450
446
  42
451
- 43
452
- 44</pre>
447
+ 43</pre>
453
448
  </td>
454
449
  <td>
455
450
  <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/security_configuration_assessment.rb', line 41</span>
456
451
 
457
452
  <span class='kw'>def</span> <span class='id identifier rubyid_checks_sca_database'>checks_sca_database</span><span class='lparen'>(</span><span class='id identifier rubyid_agent_id'>agent_id</span><span class='comma'>,</span> <span class='id identifier rubyid_policy_id'>policy_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>
458
- <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/sca/</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'>/checks/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_policy_id'>policy_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>
459
- <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_items'>items</span>
453
+ <span class='id identifier rubyid_offset_request'>offset_request</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>get</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/sca/</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'>/checks/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_policy_id'>policy_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><span class='rparen'>)</span>
460
454
  <span class='kw'>end</span></pre>
461
455
  </td>
462
456
  </tr>
@@ -475,8 +469,7 @@ the beginning to list in ascending or descending order.</p>
475
469
  </h3><div class="docstring">
476
470
  <div class="discussion">
477
471
 
478
- <p>Get security configuration assessment (SCA) database Returns the sca
479
- database of an agent</p>
472
+ <p>Get security configuration assessment (SCA) database Returns the sca database of an agent</p>
480
473
 
481
474
 
482
475
  </div>
@@ -602,8 +595,7 @@ database of an agent</p>
602
595
  </span>
603
596
 
604
597
  &mdash; <div class='inline'>
605
- <p>Sorts the collection by a field or fields (separated by comma). Use +/- at
606
- the beginning to list in ascending or descending order.</p>
598
+ <p>Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.</p>
607
599
  </div>
608
600
 
609
601
  </li>
@@ -629,8 +621,7 @@ the beginning to list in ascending or descending order.</p>
629
621
  </span>
630
622
 
631
623
  &mdash; <div class='inline'>
632
- <p>Query to filter results by. This is specially useful to filter by total
633
- checks passed, failed or total score (fields pass, fail, score).</p>
624
+ <p>Query to filter results by. This is specially useful to filter by total checks passed, failed or total score (fields pass, fail, score).</p>
634
625
  </div>
635
626
 
636
627
  </li>
@@ -652,17 +643,15 @@ checks passed, failed or total score (fields pass, fail, score).</p>
652
643
  <pre class="lines">
653
644
 
654
645
 
646
+ 67
655
647
  68
656
- 69
657
- 70
658
- 71</pre>
648
+ 69</pre>
659
649
  </td>
660
650
  <td>
661
- <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/security_configuration_assessment.rb', line 68</span>
651
+ <pre class="code"><span class="info file"># File 'lib/wazuh/api/endpoints/security_configuration_assessment.rb', line 67</span>
662
652
 
663
653
  <span class='kw'>def</span> <span class='id identifier rubyid_sca_database'>sca_database</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='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
664
- <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/sca/</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>
665
- <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_items'>items</span>
654
+ <span class='id identifier rubyid_offset_request'>offset_request</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>get</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/sca/</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><span class='rparen'>)</span>
666
655
  <span class='kw'>end</span></pre>
667
656
  </td>
668
657
  </tr>
@@ -674,9 +663,9 @@ checks passed, failed or total score (fields pass, fail, score).</p>
674
663
  </div>
675
664
 
676
665
  <div id="footer">
677
- Generated on Tue Feb 18 20:12:28 2020 by
666
+ Generated on Thu Feb 3 21:40:18 2022 by
678
667
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
679
- 0.9.16 (ruby-2.5.1).
668
+ 0.9.25 (ruby-2.6.3).
680
669
  </div>
681
670
 
682
671
  </div>
@@ -6,15 +6,15 @@
6
6
  <title>
7
7
  Module: Wazuh::Api::Endpoints::Summary
8
8
 
9
- &mdash; Documentation by YARD 0.9.16
9
+ &mdash; Documentation by YARD 0.9.25
10
10
 
11
11
  </title>
12
12
 
13
- <link rel="stylesheet" href="../../../css/style.css" type="text/css" charset="utf-8" />
13
+ <link rel="stylesheet" href="../../../css/style.css" type="text/css" />
14
14
 
15
- <link rel="stylesheet" href="../../../css/common.css" type="text/css" charset="utf-8" />
15
+ <link rel="stylesheet" href="../../../css/common.css" type="text/css" />
16
16
 
17
- <script type="text/javascript" charset="utf-8">
17
+ <script type="text/javascript">
18
18
  pathId = "Wazuh::Api::Endpoints::Summary";
19
19
  relpath = '../../../';
20
20
  </script>
@@ -76,7 +76,7 @@
76
76
 
77
77
  <dl>
78
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>
79
+ <dd><span class='object_link'><a href="../Endpoints.html" title="Wazuh::Api::Endpoints (module)">Wazuh::Api::Endpoints</a></span>, <span class='object_link'><a href="V4/Summary.html" title="Wazuh::Api::Endpoints::V4::Summary (module)">V4::Summary</a></span></dd>
80
80
  </dl>
81
81
 
82
82
 
@@ -189,9 +189,9 @@
189
189
  </div>
190
190
 
191
191
  <div id="footer">
192
- Generated on Tue Feb 18 20:12:28 2020 by
192
+ Generated on Thu Feb 3 21:40:18 2022 by
193
193
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
194
- 0.9.16 (ruby-2.5.1).
194
+ 0.9.25 (ruby-2.6.3).
195
195
  </div>
196
196
 
197
197
  </div>