Skip to content

Commit 5481491

Browse files
ayodekoayodeko
authored
Merge pull request #8780 from wazuh/enhancement/idr-275-update-command-outputs2
Update Wazuh server API command output examples
2 parents 767a04d + 96b5673 commit 5481491

File tree

5 files changed

+66
-52
lines changed

5 files changed

+66
-52
lines changed

‎CHANGELOG.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ All notable changes to this project will be documented in this file.
4747
- **Post-release**: Updated the vulnerability detection capability section. ([#8693](https://github.com/wazuh/wazuh-documentation/pull/8693))
4848
- **Post-release**: Changed the warning note on using the `$` and `&` characters when changing passwords in Docker deployments. ([#8694](https://github.com/wazuh/wazuh-documentation/pull/8694))
4949
- **Post-release**: Changed Windows commands in the backup guide to PowerShell. ([#8761](https://github.com/wazuh/wazuh-documentation/pull/8761))
50-
- **Post-release**: Updated 4.12.0 command output examples. ([#8779](https://github.com/wazuh/wazuh-documentation/pull/8779))
50+
- **Post-release**: Updated 4.12.0 command output examples. ([#8779](https://github.com/wazuh/wazuh-documentation/pull/8779)) ([#8780](https://github.com/wazuh/wazuh-documentation/pull/8780))
5151

5252
### Fixed
5353

‎source/user-manual/agent/agent-management/remote-upgrading/upgrading-agent.rst‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -200,21 +200,21 @@ Using the RESTful API
200200
:class: output
201201
202202
{
203-
"data": {
204-
"affected_items": [
205-
{
206-
"id": "002",
207-
"version": "Wazuh 4.8.0"
208-
},
209-
{
210-
"id": "003",
211-
"version": "Wazuh 4.8.0"
212-
}
213-
],
214-
"total_affected_items": 2,
215-
"total_failed_items": 0,
216-
"failed_items": []
217-
},
218-
"message": "All selected agents information was returned",
219-
"error": 0
203+
"data": {
204+
"affected_items": [
205+
{
206+
"id": "002",
207+
"version": "Wazuh v4.12.0"
208+
},
209+
{
210+
"id": "003",
211+
"version": "Wazuh v4.12.0"
212+
}
213+
],
214+
"total_affected_items": 2,
215+
"total_failed_items": 0,
216+
"failed_items": []
217+
},
218+
"message": "All selected agents information was returned",
219+
"error": 0
220220
}

‎source/user-manual/api/getting-started.rst‎

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -84,20 +84,21 @@ To ensure secure access, all Wazuh server API endpoints require authentication.
8484

8585
.. code-block:: console
8686
87-
# curl -k -X GET "https://localhost:55000/" -H "Authorization: Bearer $TOKEN"
87+
# curl -k -X GET "https://localhost:55000/?pretty=true" -H "Authorization: Bearer $TOKEN"
8888
8989
.. code-block:: none
9090
:class: output
9191
9292
{
93-
"data": {
94-
"title": "Wazuh API REST",
95-
"api_version": "4.7.4",
96-
"revision": 40717,
97-
"license_name": "GPL 2.0",
98-
"license_url": "https://github.com/wazuh/wazuh/blob/master/LICENSE",
99-
"hostname": "wazuh-master",
100-
"timestamp": "2024-05-14T21:34:15Z"},
93+
"data": {
94+
"title": "Wazuh API REST",
95+
"api_version": "4.12.0",
96+
"revision": "rc1",
97+
"license_name": "GPL 2.0",
98+
"license_url": "https://github.com/wazuh/wazuh/blob/v4.12.0/LICENSE",
99+
"hostname": "centos8a",
100+
"timestamp": "2025-08-18T19:05:19Z"
101+
},
101102
"error": 0
102103
}
103104
@@ -489,22 +490,22 @@ The following GET request retrieves basic information about the Wazuh server API
489490

490491
.. code-block:: console
491492
492-
# curl -k -X GET "https://localhost:55000/" -H "Authorization: Bearer $TOKEN"
493+
# curl -k -X GET "https://localhost:55000/?pretty=true" -H "Authorization: Bearer $TOKEN"
493494
494495
.. code-block:: none
495496
:class: output
496497
497498
{
498-
"data": {
499-
"title": "Wazuh API",
500-
"api_version": "4.7.4",
501-
"revision": 40717,
502-
"license_name": "GPL 2.0",
503-
"license_url": "https://github.com/wazuh/wazuh/blob/master/LICENSE",
504-
"hostname": "wazuh-master",
505-
"timestamp": "2024-05-14T21:34:15Z"
506-
},
507-
"error": 0
499+
"data": {
500+
"title": "Wazuh API REST",
501+
"api_version": "4.12.0",
502+
"revision": "rc1",
503+
"license_name": "GPL 2.0",
504+
"license_url": "https://github.com/wazuh/wazuh/blob/v4.12.0/LICENSE",
505+
"hostname": "centos8a",
506+
"timestamp": "2025-08-18T19:19:56Z"
507+
},
508+
"error": 0
508509
}
509510
510511
POST

‎source/user-manual/capabilities/system-inventory/viewing-system-inventory-data.rst‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -184,28 +184,30 @@ Follow the steps below to query the endpoint database from the command line usin
184184
185185
curl -k -X GET "https://<WAZUH_SERVER_IP>:55000/syscollector/001/packages?pretty=true&name=wazuh-agent" -H "Authorization: Bearer $TOKEN"
186186
187-
188187
.. code-block:: console
189188
:class: output
190-
:emphasize-lines: 14
191-
189+
:emphasize-lines: 9
190+
192191
{
193192
"data": {
194193
"affected_items": [
195194
{
196195
"scan": {
197196
"id": 0,
198-
"time": "2023-08-09T06:49:25+00:00"
197+
"time": "2025-08-18T16:50:06+00:00"
199198
},
200-
"architecture": "x86_64",
201-
"description": "Wazuh helps you to gain security visibility into your infrastructure by monitoring hosts at an operating system and application level. It provides the following capabilities: log analysis, file integrity monitoring, intrusions detection and policy and compliance monitoring",
202-
"format": "rpm",
203-
"size": 25951010,
204-
"install_time": "1691563709",
205199
"name": "wazuh-agent",
206200
"section": "System Environment/Daemons",
201+
"architecture": "x86_64",
202+
"description": "Wazuh helps you to gain security visibility into your infrastructure by monitoring\nhosts at an operating system and application level. It provides the following capabilities:\nlog analysis, file integrity monitoring, intrusions detection and policy and compliance monitoring",
203+
"location": " ",
204+
"source": " ",
205+
"format": "rpm",
206+
"install_time": "1755535740",
207+
"version": "4.12.0-1",
208+
"size": 30461944,
209+
"priority": " ",
207210
"vendor": "Wazuh, Inc <[email protected]>",
208-
"version": "4.5.0-1",
209211
"agent_id": "001"
210212
}
211213
],

‎source/user-manual/wazuh-dashboard/troubleshooting.rst‎

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,26 @@ If the Wazuh server API is running, try to fetch data using the CLI from the Waz
1919

2020
.. code-block:: console
2121
22-
# curl -k -X GET "https://<api_url>:55000/" -H "Authorization: Bearer $(curl -u <api_user>:<api_password> -k -X POST 'https://<api_url>:55000/security/user/authenticate?raw=true')"
22+
# curl -k -X GET "https://<api_url>:55000/?pretty=true" -H "Authorization: Bearer $(curl -u <api_user>:<api_password> -k -X POST 'https://<api_url>:55000/security/user/authenticate?raw=true')"
2323
2424
.. code-block:: none
2525
:class: output
2626
27-
% Total % Received % Xferd Average Speed Time Time Time Current
27+
% Total % Received % Xferd Average Speed Time Time Time Current
2828
Dload Upload Total Spent Left Speed
29-
100 404 100 404 0 0 2779 0 --:--:-- --:--:-- --:--:-- 2786
30-
{"data": {"title": "Wazuh API REST", "api_version": "4.8.0", "revision": 40812, "license_name": "GPL 2.0", "license_url": "https://github.com/wazuh/wazuh/blob/v4.8.0/LICENSE", "hostname": "wazuh-server", "timestamp": "2024-07-18T20:06:45Z"}, "error": 0}
29+
100 398 100 398 0 0 3431 0 --:--:-- --:--:-- --:--:-- 3431
30+
{
31+
"data": {
32+
"title": "Wazuh API REST",
33+
"api_version": "4.12.0",
34+
"revision": "rc1",
35+
"license_name": "GPL 2.0",
36+
"license_url": "https://github.com/wazuh/wazuh/blob/v4.12.0/LICENSE",
37+
"hostname": "centos8a",
38+
"timestamp": "2025-08-18T19:31:01Z"
39+
},
40+
"error": 0
41+
}
3142
3243
.. code-block:: none
3344
:class: output

0 commit comments

Comments
 (0)