Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update API configuration options for new EPS limits #5417

Merged
merged 1 commit into from
Jul 6, 2022
Merged

Update API configuration options for new EPS limits #5417

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions source/user-manual/api/configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,16 +277,37 @@ access
| max_request_per_minute | Any positive integer | 300 | Establish a maximum number of requests the Wazuh API can handle per minute (does not include authentication requests). If the number of requests for a given minute is exceeded, all incoming requests (from any user) will be blocked for the remaining time. This feature can be disabled by setting its value to 0. |
+------------------------+----------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


upload_configuration
^^^^^^^^^^^^^^^^^^^^

.. versionadded:: 4.4.0

remote_commands (localfile and wodle "command")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

+------------+----------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Sub-fields | Allowed values | Default value | Description |
+============+======================+===============+=============================================================================================================================================================================================================================================================================================================================================+
| enabled | yes, true, no, false | true | Enable or disable uploading configurations with remote commands through the Wazuh API. When this option is disabled it is not possible to upload **ossec.conf** files with the <command> option inside the :ref:`localfile tag <reference_ossec_localfile>` as well as the :ref:`wodle "command" option <wodle_command>`. |
| allow | yes, true, no, false | true | Allow uploading configurations with remote commands through the Wazuh API. When this option is ``false`` it is not possible to upload **ossec.conf** files with the <command> option inside the :ref:`localfile tag <reference_ossec_localfile>` as well as the :ref:`wodle "command" option <wodle_command>`. |
+------------+----------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| exceptions | command list | [ ] | Set a list of commands allowed to be uploaded through the API. These exceptions could always be uploaded independently of the value of the enabled config |
+------------+----------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

limits
~~~~~~

.. rubric:: eps
:class: h5

.. versionadded:: 4.4.0

+------------+----------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Sub-fields | Allowed values | Default value | Description |
+============+======================+===============+=============================================================================================================================================================================================================================================================================================================================================+
| allow | yes, true, no, false | true | Allow uploading configurations with EPS limits through the Wazuh API. When this option is ``false`` it is not possible to upload **ossec.conf** files with <limits><eps> inside the :ref:`localfile tag <reference_ossec_localfile>`. |
+------------+----------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

.. _api_security_configuration_options:

Security configuration options
Expand Down