A flexible Python API client for interacting with the Wazuh API (currently supporting version 4).
Project description
Wazuh API client
A flexible Python client for interacting with the Wazuh API.
Supports 4.x version with modular route handlers and extensive functionality for managing agents, configurations, and more.
Overview
The Wazuh API client aims to simplify integrations with the Wazuh API by providing well-documented methods and abstractions for each available endpoint. Whether you need to manage agents, retrieve system configurations, or interface with other Wazuh components, this SDK offers a consistent and easy-to-use interface for your Python applications.
Usage
from wazuh_api_client import AsyncWazuhClient
from wazuh_api_client.managers import AgentsManager, SysCheckManager
async with AsyncWazuhClient(
base_url="https://172.0.0.1:55000",
username="wazuh",
password="wazuh",
version="4",
) as async_client:
agents_manager = AgentsManager(client=async_client)
syscheck_manager = SysCheckManager(client=async_client)
# res = await agents_manager.list()
# print(res)
print(await syscheck_manager.get_results(agent_id="001"))
print(await syscheck_manager.clear_results(agent_id="001"))
print(await syscheck_manager.get_last_scan_datetime(agent_id="001"))
Installation
From Source
Clone the repository and install in editable mode:
git clone https://github.com/moadennagi/wazuh-api-client.git
cd wazuh-api-client
pip install -e .
From Pypi
pip install wazuh-api-client
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file wazuh_api_client-0.1.1b0.tar.gz.
File metadata
- Download URL: wazuh_api_client-0.1.1b0.tar.gz
- Upload date:
- Size: 14.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a9570049548d6063c8208f413c133643b459c29d6ea3c93672ecc9f0a6596ff4
|
|
| MD5 |
9620bdcd166a3c6fc8231b7a20d4f5cf
|
|
| BLAKE2b-256 |
9adf8f345f8a1932fc4f932ea0e36212d071d7770d4f560e923efa633930a0f8
|
File details
Details for the file wazuh_api_client-0.1.1b0-py3-none-any.whl.
File metadata
- Download URL: wazuh_api_client-0.1.1b0-py3-none-any.whl
- Upload date:
- Size: 18.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6a52b31d41078e349c1c7e57bfb0064dea47151b052815c07e5ba9b94a78bbd9
|
|
| MD5 |
1a1efb165a5997939b69dfbc92d92f4b
|
|
| BLAKE2b-256 |
4ab52c4b1f8c4f1fa21af3445d68dc41957f2b6f86b92e3d5e33acd78b872c18
|