From 64fd105e9898a840351b87298d93624d7971eedf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=ADctor=20Fern=C3=A1ndez=20Poyatos?= Date: Tue, 5 Jul 2022 16:56:31 +0200 Subject: [PATCH] Update API configuration options --- source/user-manual/api/configuration.rst | 25 ++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/source/user-manual/api/configuration.rst b/source/user-manual/api/configuration.rst index bf2168f07f..08fd3cc382 100644 --- a/source/user-manual/api/configuration.rst +++ b/source/user-manual/api/configuration.rst @@ -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 option inside the :ref:`localfile tag ` as well as the :ref:`wodle "command" option `. | +| 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 option inside the :ref:`localfile tag ` as well as the :ref:`wodle "command" option `. | +------------+----------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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 inside the :ref:`localfile tag `. | ++------------+----------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + .. _api_security_configuration_options: Security configuration options