Reference

This API reference is organized by resources:

Active Response
Agents
Cache
Ciscat
Cluster
Decoders
Experimental
Lists
Manager
Rootcheck
Rules
Security Configuration Assessment
Summary
Syscheck
Syscollector

Below is the Request List that shows all of the available requests.

Request List

Active Response

PUT /active-response/:agent_id (Run an AR command in the agent)

Agents

DELETE /agents (Delete agents)
DELETE /agents/:agent_id (Delete an agent)
DELETE /agents/:agent_id/group (Remove all agent groups.)
DELETE /agents/:agent_id/group/:group_id (Remove a single group of an agent)
DELETE /agents/group/:group_id (Remove a single group of multiple agents)
DELETE /agents/groups (Delete a list of groups)
DELETE /agents/groups/:group_id (Remove group)
GET /agents (Get all agents)
GET /agents/:agent_id (Get an agent)
GET /agents/:agent_id/config/:component/:configuration (Get active configuration)
GET /agents/:agent_id/group/is_sync (Get sync status of agent)
GET /agents/:agent_id/key (Get agent key)
GET /agents/:agent_id/upgrade_result (Get upgrade result from agent)
GET /agents/groups (Get groups)
GET /agents/groups/:group_id (Get agents in a group)
GET /agents/groups/:group_id/configuration (Get group configuration)
GET /agents/groups/:group_id/files (Get group files)
GET /agents/groups/:group_id/files/:filename (Get a file in group)
GET /agents/name/:agent_name (Get an agent by its name)
GET /agents/no_group (Get agents without group)
GET /agents/outdated (Get outdated agents)
GET /agents/stats/distinct (Get distinct fields in agents)
GET /agents/summary (Get agents summary)
GET /agents/summary/os (Get OS summary)
POST /agents (Add agent)
POST /agents/group/:group_id (Add a list of agents to a group)
POST /agents/groups/:group_id/configuration (Put configuration file (agent.conf) into a group)
POST /agents/groups/:group_id/files/:file_name (Upload file into a group)
POST /agents/insert (Insert agent)
POST /agents/restart (Restart a list of agents)
PUT /agents/:agent_id/group/:group_id (Add agent group)
PUT /agents/:agent_id/restart (Restart an agent)
PUT /agents/:agent_id/upgrade (Upgrade agent using online repository)
PUT /agents/:agent_id/upgrade_custom (Upgrade agent using custom file)
PUT /agents/:agent_name (Add agent (quick method))
PUT /agents/groups/:group_id (Create a group)
PUT /agents/groups/:group_id/restart (Restart agents which belong to a group)
PUT /agents/restart (Restart all agents)

Cache

DELETE /cache (Delete cache index)
DELETE /cache/:group (Clear group cache)
GET /cache (Get cache index)
GET /cache/config (Return cache configuration)

Ciscat

GET /ciscat/:agent_id/results (Get CIS-CAT results from an agent)

Cluster

DELETE /cluster/:node_id/files (Delete a remote file in a cluster node)
GET /cluster/:node_id/config/:component/:configuration (Get active configuration in node node_id)
GET /cluster/:node_id/configuration (Get node node_id's configuration)
GET /cluster/:node_id/configuration/validation (Check Wazuh configuration in a cluster node)
GET /cluster/:node_id/files (Get local file from any cluster node)
GET /cluster/:node_id/info (Get node_id's information)
GET /cluster/:node_id/logs (Get ossec.log from a specific node in cluster.)
GET /cluster/:node_id/logs/summary (Get summary of ossec.log from a specific node in cluster.)
GET /cluster/:node_id/stats (Get node node_id's stats)
GET /cluster/:node_id/stats/analysisd (Get node node_id's analysisd stats)
GET /cluster/:node_id/stats/hourly (Get node node_id's stats by hour)
GET /cluster/:node_id/stats/remoted (Get node node_id's remoted stats)
GET /cluster/:node_id/stats/weekly (Get node node_id's stats by week)
GET /cluster/:node_id/status (Get node node_id's status)
GET /cluster/config (Get the cluster configuration)
GET /cluster/configuration/validation (Check Wazuh configuration in all cluster nodes)
GET /cluster/healthcheck (Show cluster health)
GET /cluster/node (Get local node info)
GET /cluster/nodes (Get nodes info)
GET /cluster/nodes/:node_name (Get node info)
GET /cluster/status (Get info about cluster status)
POST /cluster/:node_id/files (Update local file at any cluster node)
PUT /cluster/:node_id/restart (Restart a specific node in cluster)
PUT /cluster/restart (Restart all nodes in cluster)

Decoders

GET /decoders (Get all decoders)
GET /decoders/:decoder_name (Get decoders by name)
GET /decoders/files (Get all decoders files)
GET /decoders/parents (Get all parent decoders)

Experimental

DELETE /experimental/syscheck (Clear syscheck database)
GET /experimental/ciscat/results (Get CIS-CAT results)
GET /experimental/syscollector/hardware (Get hardware info of all agents)
GET /experimental/syscollector/netaddr (Get network address info of all agents)
GET /experimental/syscollector/netiface (Get network interface info of all agents)
GET /experimental/syscollector/netproto (Get network protocol info of all agents)
GET /experimental/syscollector/os (Get os info of all agents)
GET /experimental/syscollector/packages (Get packages info of all agents)
GET /experimental/syscollector/ports (Get ports info of all agents)
GET /experimental/syscollector/processes (Get processes info of all agents)

Lists

GET /lists (Get all lists)
GET /lists/files (Get paths from all lists)

Manager

DELETE /manager/files (Delete a local file)
GET /manager/config/:component/:configuration (Get manager active configuration)
GET /manager/configuration (Get manager configuration)
GET /manager/configuration/validation (Check Wazuh configuration)
GET /manager/files (Get local file)
GET /manager/info (Get manager information)
GET /manager/logs (Get ossec.log)
GET /manager/logs/summary (Get summary of ossec.log)
GET /manager/stats (Get manager stats)
GET /manager/stats/analysisd (Get analysisd stats)
GET /manager/stats/hourly (Get manager stats by hour)
GET /manager/stats/remoted (Get remoted stats)
GET /manager/stats/weekly (Get manager stats by week)
GET /manager/status (Get manager status)
POST /manager/files (Update local file)
PUT /manager/restart (Restart Wazuh manager)

Rootcheck

DELETE /rootcheck (Clear rootcheck database)
DELETE /rootcheck/:agent_id (Clear rootcheck database of an agent)
GET /rootcheck/:agent_id (Get rootcheck database)
GET /rootcheck/:agent_id/cis (Get rootcheck CIS requirements)
GET /rootcheck/:agent_id/last_scan (Get last rootcheck scan)
GET /rootcheck/:agent_id/pci (Get rootcheck pci requirements)
PUT /rootcheck (Run rootcheck scan in all agents)
PUT /rootcheck/:agent_id (Run rootcheck scan in an agent)

Rules

GET /rules (Get all rules)
GET /rules/:rule_id (Get rules by id)
GET /rules/files (Get files of rules)
GET /rules/gdpr (Get rule gdpr requirements)
GET /rules/gpg13 (Get rule gpg13 requirements)
GET /rules/groups (Get rule groups)
GET /rules/hipaa (Get rule hipaa requirements)
GET /rules/nist-800-53 (Get rule nist-800-53 requirements)
GET /rules/pci (Get rule pci requirements)

Security Configuration Assessment

GET /sca/:agent_id (Get security configuration assessment (SCA) database)
GET /sca/:agent_id/checks/:policy_id (Get security configuration assessment (SCA) checks database)

Summary

GET /summary/agents (Get a full summary of agents)

Syscheck

DELETE /syscheck/:agent_id (Clear syscheck database of an agent)
GET /syscheck/:agent_id (Get syscheck files)
GET /syscheck/:agent_id/last_scan (Get last syscheck scan)
PUT /syscheck (Run syscheck scan in all agents)
PUT /syscheck/:agent_id (Run syscheck scan in an agent)

Syscollector

GET /syscollector/:agent_id/hardware (Get hardware info)
GET /syscollector/:agent_id/hotfixes (Get hotfixes info)
GET /syscollector/:agent_id/netaddr (Get network address info of an agent)
GET /syscollector/:agent_id/netiface (Get network interface info of an agent)
GET /syscollector/:agent_id/netproto (Get network protocol info of an agent)
GET /syscollector/:agent_id/os (Get os info)
GET /syscollector/:agent_id/packages (Get packages info)
GET /syscollector/:agent_id/ports (Get ports info of an agent)
GET /syscollector/:agent_id/processes (Get processes info)

Active Response

Command

Run an AR command in the agent

Runs an Active Response command on a specified agent.

Request:

PUT

/active-response/:agent_id

Parameters:

Param	Type	Description
`agent_id`	Number	Agent ID.
`command`	String	Command running in the agent. If this value starts by !, then it refers to a script name instead of a command name.
`custom`	Boolean	Whether the specified command is a custom command or not.
`arguments`	String[]	Array with command arguments.

Example Request:

curl -u foo:bar -k -X PUT -d '{"command":"restart-ossec0", "arguments": ["-", "null", "(from_the_server)", "(no_rule_id)"]}' -H 'Content-Type:application/json' "https://127.0.0.1:55000/active-response/001?pretty"

Example Response:

{
    "error": 0,
    "data": "Command sent."
}

Agents

Add

Add agent

Add a new agent.

Request:

POST

/agents

Parameters:

Param

Type

Description

name

String

Agent name.

ip

String

If this is not included, the API will get the IP automatically. If you are behind a proxy, you must set the option config.BehindProxyServer to yes at config.js.

Allowed values:

IP
IP/NET
ANY

force

Number

Remove the old agent with the same IP if disconnected since <force> seconds.

Example Request:

curl -u foo:bar -k -X POST -d '{"name":"NewHost","ip":"10.0.0.9"}' -H 'Content-Type:application/json' "https://127.0.0.1:55000/agents?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "id": "009",
      "key": "MDA5IE5ld0hvc3QgMTAuMC4wLjkgZDk1NGI0ODZmYWEyNDVlMjdhOTVmM2ZmNDU3OWYxMmM5MjZjY2QwY2QxZmY1YzE5OGZiYmExYTI4ZTg1MzVlNA=="
   }
}

Add agent (quick method)

Adds a new agent with name :agent_name. This agent will use ANY as IP.

Request:

PUT

/agents/:agent_name

Parameters:

Param	Type	Description
`agent_name`	String	Agent name.

Example Request:

curl -u foo:bar -k -X PUT "https://127.0.0.1:55000/agents/myNewAgent?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "id": "010",
      "key": "MDEwIG15TmV3QWdlbnQgYW55IDZkZTc5ZmQwMmIwZWNkNjVjNzU1ZDBhNDkzM2ZlMTdmZWQ5MDQ0OTMyZTRmYmIzMmJkZmZmYWYzOTVkZWIyYjQ="
   }
}

Insert agent

Insert an agent with an existing id and key.

Request:

POST

/agents/insert

Parameters:

Param	Type	Description
`name`	String	Agent name.
`ip`	String	If this is not included, the API will get the IP automatically. If you are behind a proxy, you must set the option config.BehindProxyServer to yes at config.js. Allowed values: IP IP/NET ANY
`id`	String	Agent ID.
`key`	String	Agent key. Minimum length: 64 characters. Allowed values: ^[a-zA-Z0-9]+$
`force`	Number	Remove the old agent the with same IP if disconnected since <force> seconds.

Example Request:

curl -u foo:bar -k -X POST -d '{"name":"NewHost_2","ip":"10.0.10.10","id":"123","key":"1abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghi64"}' -H 'Content-Type:application/json' "https://127.0.0.1:55000/agents/insert?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "id": "123",
      "key": "MTIzIE5ld0hvc3RfMiAxMC4wLjEwLjEwIDFhYmNkZWZnaGlqa2xtbm9wcXJzdHV2d3h5emFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6YWJjZGVmZ2hpNjQ="
   }
}

Config

Get active configuration

Returns the active configuration in JSON format.

Request:

GET

/agents/:agent_id/config/:component/:configuration

Parameters:

Param

Type

Description

agent_id

Number

Agent ID.

component

String

Selected component.

Allowed values:

agent
agentless
analysis
auth
com
csyslog
integrator
logcollector
mail
monitor
request
syscheck
wmodules

configuration

String

Configuration to read.

Allowed values:

client
buffer
labels
internal
agentless
global
active_response
alerts
command
rules
decoders
internal
auth
active-response
internal
cluster
csyslog
integration
localfile
socket
remote
syscheck
rootcheck
wmodules

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/agents/001/config/logcollector/localfile?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "localfile": [
         {
            "logformat": "command",
            "command": "df -P",
            "alias": "df -P",
            "ignore_binaries": "no",
            "target": [
               "agent"
            ],
            "frequency": 360,
            "only-future-events": "yes"
         },
         {
            "logformat": "full_command",
            "command": "netstat -tulpn | sed 's/\\([[:alnum:]]\\+\\)\\ \\+[[:digit:]]\\+\\ \\+[[:digit:]]\\+\\ \\+\\(.*\\):\\([[:digit:]]*\\)\\ \\+\\([0-9\\.\\:\\*]\\+\\).\\+\\ \\([[:digit:]]*\\/[[:alnum:]\\-]*\\).*/\\1 \\2 == \\3 == \\4 \\5/' | sort -k 4 -g | sed 's/ == \\(.*\\) ==/:\\1/' | sed 1,2d",
            "alias": "netstat listening ports",
            "ignore_binaries": "no",
            "target": [
               "agent"
            ],
            "frequency": 360,
            "only-future-events": "yes"
         },
         {
            "logformat": "full_command",
            "command": "last -n 20",
            "alias": "last -n 20",
            "ignore_binaries": "no",
            "target": [
               "agent"
            ],
            "frequency": 360,
            "only-future-events": "yes"
         },
         {
            "file": "/var/ossec/logs/active-responses.log",
            "logformat": "syslog",
            "ignore_binaries": "no",
            "target": [
               "agent"
            ],
            "only-future-events": "yes"
         }
      ]
   }
}

Delete

Delete a list of groups

Removes a list of groups.

Request:

DELETE

/agents/groups

Parameters:

Param	Type	Description
`ids`	String	Name of groups separated by commas.

Example Request:

curl -u foo:bar -k -X DELETE "https://127.0.0.1:55000/agents/groups?ids=webserver,database&pretty"

Example Response:

{
   "error": 0,
   "data": {
      "msg": "All selected groups were removed",
      "ids": [
         "webserver",
         "database"
      ],
      "affected_agents": [
         "002",
         "005",
         "003"
      ]
   }
}

Delete agents

Removes agents, using a list of them or a criterion based on the status or time of the last connection.

Request:

DELETE

/agents

Parameters:

Param	Type	Description
`ids`	String	Agent IDs separated by commas.
`purge`	Boolean	Delete an agent from the key store. This parameter is only valid if purge is set to no in the manager's ossec.conf.
`status`	String	Filters by agent status. Use commas to enter multiple statuses. Allowed values: - active - pending - neverconnected - disconnected
`older_than`	String	Filters agents that have been disconnected longer than specified, by checking their Last Keep Alive value. Time in seconds, '[n_days]d', '[n_hours]h', '[n_minutes]m' or '[n_seconds]s'. For never connected agents, it uses their register date. Default value: 7d.

Example Request:

curl -u foo:bar -k -X DELETE "https://127.0.0.1:55000/agents?older_than=10s&purge&ids=003,005&pretty"

Example Response:

{
   "error": 0,
   "data": {
      "msg": "Some agents were not removed",
      "affected_agents": [
            "003"
      ],
      "failed_ids": [
         {
            "id": "005",
            "error": {
               "message": "Agent is not eligible for removal: The agent has a status different to 'all' or the specified time frame 'older_than 10s' does not apply.",
               "code": 1731
            }
         }
      ],
      "older_than": "10s",
      "total_affected_agents": 1,
      "total_failed_ids": 1
   }
}

Delete an agent

Removes an agent.

Request:

DELETE

/agents/:agent_id

Parameters:

Param	Type	Description
`agent_id`	Number	Agent ID.
`purge`	Boolean	Delete an agent from the key store. This parameter is only valid if purge is set to no in the manager's ossec.conf.

Example Request:

curl -u foo:bar -k -X DELETE "https://127.0.0.1:55000/agents/008?pretty&purge"

Example Response:

{
   "error": 0,
   "data": {
      "msg": "All selected agents were removed",
      "affected_agents": [
         "008"
      ]
   }
}

Group

Get sync status of agent

Returns the sync status in JSON format.

Request:

GET

/agents/:agent_id/group/is_sync

Parameters:

Param	Type	Description
`agent_id`	Number	Agent ID.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/agents/001/group/is_sync?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "synced": false
   }
}

Groups

Add a list of agents to a group

Adds a list of agents to the specified group.

Request:

POST

/agents/group/:group_id

Parameters:

Param	Type	Description
`ids`	String[]	List of agents ID.
`group_id`	String	Group ID.

Example Request:

curl -u foo:bar -X POST -H "Content-Type:application/json" -d '{"ids":["001","002"]}' "https://127.0.0.1:55000/agents/group/dmz?pretty" -k

Example Response:

{
   "error": 0,
   "data": {
      "msg": "All selected agents assigned to group dmz",
      "affected_agents": [
         "001",
         "002"
      ]
   }
}

Add agent group

Adds an agent to the specified group.

Request:

PUT

/agents/:agent_id/group/:group_id

Parameters:

Param	Type	Description
`agent_id`	Number	Agent unique ID.
`group_id`	String	Group ID.
`force_single_group`	Boolean	Whether to append new group to current agent's group or replace it.

Example Request:

curl -u foo:bar -k -X PUT "https://127.0.0.1:55000/agents/004/group/dmz?pretty"

Example Response:

{
   "error": 0,
   "data": "Group 'dmz' added to agent '004'."
}

Create a group

Creates a new group.

Request:

PUT

/agents/groups/:group_id

Parameters:

Param	Type	Description
`group_id`	String	Group ID.

Example Request:

curl -u foo:bar -k -X PUT "https://127.0.0.1:55000/agents/groups/pciserver?pretty"

Example Response:

{
   "error": 0,
   "data": "Group 'pciserver' created."
}

Get a file in group

Returns the specified file belonging to the group parsed to JSON.

Request:

GET

/agents/groups/:group_id/files/:filename

Parameters:

Param	Type	Description
`group_id`	String	Group ID.
`file_name`	String	Filename
`type`	String	Type of file. Allowed values: conf rootkit_files rootkit_trojans rcl
`format`	String	Optional. Output format (JSON, XML). Allowed values: json xml

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/agents/groups/webserver/files/cis_debian_linux_rcl.txt?pretty"

Example Response:

{
    "error": 0,
    "data": {
        "controls": [
            {
                "...": "..."
            },
            {
                "reference": "CIS_Debian_Benchmark_v1.0pdf",
                "name": "CIS - Testing against the CIS Debian Linux Benchmark v1",
                "condition": "all required",
                "checks": [
                    "f:/etc/debian_version;"
                ]
            }
        ]
    }
}

Get agents in a group

Returns the list of agents in a group.

Request:

GET

/agents/groups/:group_id

Parameters:

Param	Type	Description
`group_id`	String	Group ID.
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`select`	String	Select which fields to return (separated by comma).
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`status`	String	Filters by agent status. Allowed values: active pending neverconnected disconnected
`q`	String	Query to filter results by.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/agents/groups/dmz?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "os": {
               "arch": "x86_64",
               "major": "8",
               "minor": "1",
               "name": "CentOS Linux",
               "platform": "centos",
               "uname": "Linux |6df2b547e612 |5.3.0-40-generic |#32-Ubuntu SMP Fri Jan 31 20:24:34 UTC 2020 |x86_64",
               "version": "8.1"
            },
            "dateAdd": "1970-01-01 00:00:00",
            "version": "Wazuh v3.12.3",
            "manager": "1cb46c820ff5",
            "mergedSum": "6c2a4b148047e590188f8befe47c2bff",
            "id": "001",
            "ip": "172.23.0.5",
            "registerIP": "172.23.0.5",
            "status": "Active",
            "dateAdd": "2020-03-11 14:40:08",
            "group": [
               "default",
               "dmz"
            ],
            "node_name": "master",
            "name": "6df2b547e612",
            "lastKeepAlive": "2020-03-11 14:41:59"
         },
         {
            "os": {
               "arch": "x86_64",
               "major": "8",
               "minor": "1",
               "name": "CentOS Linux",
               "platform": "centos",
               "uname": "Linux |3e42938763b6 |5.3.0-40-generic |#32-Ubuntu SMP Fri Jan 31 20:24:34 UTC 2020 |x86_64",
               "version": "8.1"
            },
            "dateAdd": "2019-08-30 09:18:12",
            "version": "Wazuh v3.12.3",
            "manager": "7995615e03c0",
            "mergedSum": "6c2a4b148047e590188f8befe47c2bff",
            "id": "002",
            "ip": "172.23.0.6",
            "registerIP": "172.23.0.6",
            "status": "Active",
            "dateAdd": "2020-03-11 14:40:08",
            "group": [
               "default",
               "dmz"
            ],
            "node_name": "worker-1",
            "name": "3e42938763b6",
            "lastKeepAlive": "2020-03-11 14:41:49"
         },
         {
            "id": "004",
            "ip": "10.0.0.62",
            "registerIP": "10.0.0.62",
            "status": "Never connected",
            "dateAdd": "2020-03-11 14:41:53",
            "group": [
               "dmz"
            ],
            "node_name": "unknown",
            "name": "server001"
         }
      ],
      "totalItems": 3
   }
}

Get agents without group

Returns a list with the available agents without group.

Request:

GET

/agents/no_group

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`select`	String	Select which fields to return (separated by comma).
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`q`	String	Query to filter result. For example q="status=Active"

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/agents/no_group?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "ip": "10.0.0.15",
            "status": "Never connected",
            "node_name": "unknown",
            "registerIP": "10.0.0.15",
            "name": "main_database",
            "id": "006",
            "dateAdd": "2020-03-11 14:41:54"
         },
         {
            "ip": "10.0.0.14",
            "status": "Never connected",
            "node_name": "unknown",
            "registerIP": "10.0.0.14",
            "name": "dmz002",
            "id": "007",
            "dateAdd": "2020-03-11 14:41:54"
         },
         {
            "ip": "10.0.0.9",
            "status": "Never connected",
            "node_name": "unknown",
            "registerIP": "10.0.0.9",
            "name": "NewHost",
            "id": "009",
            "dateAdd": "2020-03-11 14:41:58"
         },
         {
            "ip": "any",
            "status": "Never connected",
            "node_name": "unknown",
            "registerIP": "any",
            "name": "myNewAgent",
            "id": "010",
            "dateAdd": "2020-03-11 14:41:58"
         },
         {
            "ip": "10.0.10.10",
            "status": "Never connected",
            "node_name": "unknown",
            "registerIP": "10.0.10.10",
            "name": "NewHost_2",
            "id": "123",
            "dateAdd": "2020-03-11 14:41:58"
         }
      ],
      "totalItems": 5
   }
}

Get group configuration

Returns the group configuration (agent.conf).

Request:

GET

/agents/groups/:group_id/configuration

Parameters:

Param	Type	Description
`group_id`	String	Group ID.
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/agents/groups/dmz/configuration?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "totalItems": 1,
      "items": [
         {
            "filters": {
               "os": "Linux"
            },
            "config": {
               "localfile": [
                  {
                     "location": "/var/log/linux.log",
                     "log_format": "syslog"
                  }
               ]
            }
         }
      ]
   }
}

Get group files

Returns the files belonging to the group.

Request:

GET

/agents/groups/:group_id/files

Parameters:

Param	Type	Description
`group_id`	String	Group ID.
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`hash`	String	Hash algorithm to use to calculate files checksums.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/agents/groups/default/files?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "filename": "agent.conf",
            "hash": "ab73af41699f13fdd81903b5f23d8d00"
         },
         {
            "filename": "ar.conf",
            "hash": "2ccd28cdc0798aeb25efbb98c1f6a1fd"
         },
         {
            "filename": "cis_apache2224_rcl.txt",
            "hash": "3c2469443a08b01c454ca35558cb9fa6"
         },
         {
            "filename": "cis_debian_linux_rcl.txt",
            "hash": "cc12fdba595817758f308024f61acb71"
         },
         {
            "filename": "cis_mysql5-6_community_rcl.txt",
            "hash": "f5f770160baf596373e4f77f987cc422"
         },
         {
            "filename": "cis_mysql5-6_enterprise_rcl.txt",
            "hash": "de9865c809f1555d537e5a49872eaf4c"
         },
         {
            "filename": "cis_rhel5_linux_rcl.txt",
            "hash": "a3af38b3f81a48332c7bcd9cf8aa6eff"
         },
         {
            "filename": "cis_rhel6_linux_rcl.txt",
            "hash": "bdcfa3ab90b553f8e5c84cfa9fd90289"
         },
         {
            "filename": "cis_rhel7_linux_rcl.txt",
            "hash": "039e579029e3edcf8241fb391f46b12f"
         },
         {
            "filename": "cis_rhel_linux_rcl.txt",
            "hash": "569cd8a2cc7527cc75f81f77098de461"
         },
         {
            "filename": "cis_sles11_linux_rcl.txt",
            "hash": "d86ee36d384930293cbcc83c8fb57c93"
         },
         {
            "filename": "cis_sles12_linux_rcl.txt",
            "hash": "6f58710fa8eef659dc782a3fa4699e33"
         },
         {
            "filename": "cis_win2012r2_domainL1_rcl.txt",
            "hash": "8819dfa3523933b113e27a85fc9e568d"
         },
         {
            "filename": "cis_win2012r2_domainL2_rcl.txt",
            "hash": "e8a2c7ab57bc8102b237f061b8f82dce"
         },
         {
            "filename": "cis_win2012r2_memberL1_rcl.txt",
            "hash": "38c88156d03af9372efd620e6e57d473"
         },
         {
            "filename": "cis_win2012r2_memberL2_rcl.txt",
            "hash": "c4b62b3e01b5f5634a9719eb8a104028"
         },
         {
            "filename": "merged.mg",
            "hash": "438c69bbca3caceabac91d821004c6ab"
         },
         {
            "filename": "rootkit_files.txt",
            "hash": "e5ddcac443143cef6237d5f9b8d48585"
         },
         {
            "filename": "rootkit_trojans.txt",
            "hash": "84b08dab2e200d846a445dcbff1487a0"
         },
         {
            "filename": "system_audit_rcl.txt",
            "hash": "20138d1fc81eb7ecc13629283fea3470"
         },
         {
            "filename": "system_audit_ssh.txt",
            "hash": "407c1f5e103f0cb58249eb7252a84797"
         },
         {
            "filename": "win_applications_rcl.txt",
            "hash": "0a4ad12c8145aca8a28d31de5c448b48"
         },
         {
            "filename": "win_audit_rcl.txt",
            "hash": "92d8011facc8b921ece301ea4ce6a616"
         },
         {
            "filename": "win_malware_rcl.txt",
            "hash": "6a8d3c63a0e77dea35aaed3ee2cca3a1"
         }
      ],
      "totalItems": 24
   }
}

Get groups

Returns the list of existing agent groups.

Request:

GET

/agents/groups

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`hash`	String	Select algorithm to generate the sum.
`q`	String	Query to filter result. For example q="name=dmz".

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/agents/groups?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "count": 4,
            "name": "default",
            "mergedSum": "438c69bbca3caceabac91d821004c6ab",
            "configSum": "ab73af41699f13fdd81903b5f23d8d00"
         },
         {
            "count": 3,
            "name": "dmz",
            "mergedSum": "c2401dcf5127bdaa9db8fbd93fee6ff5",
            "configSum": "cfbae9ecc10eb15f1b4fc736de6758cc"
         },
         {
            "count": 0,
            "name": "pciserver",
            "configSum": "ab73af41699f13fdd81903b5f23d8d00"
         }
      ],
      "totalItems": 3
   }
}

Put configuration file (agent.conf) into a group

Upload the group configuration (agent.conf).

Request:

POST

/agents/groups/:group_id/configuration

Parameters:

Param	Type	Description
`group_id`	String	Group ID.

Example Request:

curl -u foo:bar -X POST -H 'Content-type: application/xml' -d @agent.conf.xml "https://127.0.0.1:55000/agents/groups/dmz/configuration?pretty" -k

Example Response:

{
    "error": 0,
    "data": "Agent configuration was updated successfully"
}

Remove a single group of an agent

Remove the group of the agent but will leave the rest of its group if it belongs to a multigroup.

Request:

DELETE

/agents/:agent_id/group/:group_id

Parameters:

Param	Type	Description
`agent_id`	Number	Agent ID.
`group_id`	String	Group ID.

Example Request:

curl -u foo:bar -k -X DELETE "https://127.0.0.1:55000/agents/004/group/dmz?pretty"

Example Response:

{
   "error": 0,
   "data": "Agent 004 set to group default."
}

Remove a single group of multiple agents

Remove a list of agents of a group.

Request:

DELETE

/agents/group/:group_id

Parameters:

Param	Type	Description
`ids`	String	Agent IDs separated by commas.
`group_id`	String	Group ID.

Example Request:

curl -u foo:bar -k -X DELETE "https://127.0.0.1:55000/agents/group/dmz?ids=001,002&pretty"

Example Response:

{
   "error": 0,
   "data": {
      "msg": "All selected agents were removed from group dmz",
      "affected_agents": [
         "001",
         "002"
      ]
   }
}

Remove all agent groups.

Removes the group of the agent. The agent will automatically revert to the 'default' group.

Request:

DELETE

/agents/:agent_id/group

Parameters:

Param	Type	Description
`agent_id`	Number	Agent ID.

Example Request:

curl -u foo:bar -k -X DELETE "https://127.0.0.1:55000/agents/004/group?pretty"

Example Response:

{
   "error": 0,
   "data": "Group unset for agent '004'."
}

Remove group

Removes the group. Agents that were assigned to the removed group will automatically revert to the 'default' group.

Request:

DELETE

/agents/groups/:group_id

Parameters:

Param	Type	Description
`group_id`	String	Group ID.

Example Request:

curl -u foo:bar -k -X DELETE "https://127.0.0.1:55000/agents/groups/dmz?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "msg": "All selected groups were removed",
      "ids": [
         "dmz"
      ],
      "affected_agents": []
   }
}

Upload file into a group

Upload a file to a group.

Request:

POST

/agents/groups/:group_id/files/:file_name

Parameters:

Param	Type	Description
`group_id`	String	Group ID.
`file_name`	String	File name.

Example Request:

curl -u foo:bar -X POST -H 'Content-type: application/xml' -d @agent.conf.xml "https://127.0.0.1:55000/agents/groups/dmz/files/agent.conf?pretty" -k

Example Response:

{
    "error": 0,
    "data": "Agent configuration was updated successfully"
}

Info

Get OS summary

Returns a summary of the OS.

Request:

GET

/agents/summary/os

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`q`	String	Query to filter result. For example q="status=Active"

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/agents/summary/os?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "os": {
               "platform": "centos"
            }
         }
      ],
      "totalItems": 1
   }
}

Get agents summary

Returns a summary of the available agents.

Request:

GET

/agents/summary

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/agents/summary?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "Total": 11,
      "Active": 4,
      "Disconnected": 0,
      "Never connected": 7,
      "Pending": 0
   }
}

Get all agents

Returns a list with the available agents.

Request:

GET

/agents

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`select`	String	List of selected fields separated by commas.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`status`	String	Filters by agent status. Use commas to enter multiple statuses. Allowed values: - active - pending - neverconnected - disconnected
`q`	String	Query to filter results by. For example q="status=Active"
`older_than`	String	Filters agents that have been disconnected longer than specified, by checking their Last Keep Alive value. Time in seconds, '[n_days]d', '[n_hours]h', '[n_minutes]m' or '[n_seconds]s'. For never connected agents, it uses their register date. Default value: 7d
`os.platform`	String	Filters by OS platform.
`os.version`	String	Filters by OS version.
`os.name`	String	Filters by OS name.
`manager`	String	Filters by manager hostname to which agents are connected.
`version`	String	Filters by agents version.
`group`	String	Filters by group of agents.
`node_name`	String	Filters by node name.
`name`	String	Filters by agent name.
`ip`	String	Filters by agent IP.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/agents?pretty&offset=0&limit=5&sort=-ip,name"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "status": "Never connected",
            "ip": "any",
            "node_name": "unknown",
            "name": "myNewAgent",
            "id": "010",
            "dateAdd": "2020-03-11 14:41:58",
            "registerIP": "any"
         },
         {
            "os": {
               "arch": "x86_64",
               "codename": "Core",
               "major": "8",
               "name": "CentOS Linux",
               "platform": "centos",
               "uname": "Linux |51ae6aeff9b0 |5.3.0-40-generic |#32-Ubuntu SMP Fri Jan 31 20:24:34 UTC 2020 |x86_64",
               "version": "8"
            },
            "status": "Active",
            "group": [
               "default"
            ],
            "ip": "172.23.0.7",
            "manager": "7ce87f29a3ad",
            "version": "Wazuh v3.5.0",
            "node_name": "worker-2",
            "name": "51ae6aeff9b0",
            "id": "003",
            "mergedSum": "438c69bbca3caceabac91d821004c6ab",
            "lastKeepAlive": "2020-03-11 14:41:55",
            "dateAdd": "2020-03-11 14:40:09",
            "registerIP": "172.23.0.7",
            "configSum": "ab73af41699f13fdd81903b5f23d8d00"
         },
         {
            "os": {
               "arch": "x86_64",
               "major": "8",
               "minor": "1",
               "name": "CentOS Linux",
               "platform": "centos",
               "uname": "Linux |3e42938763b6 |5.3.0-40-generic |#32-Ubuntu SMP Fri Jan 31 20:24:34 UTC 2020 |x86_64",
               "version": "8.1"
            },
            "status": "Active",
            "group": [
               "default"
            ],
            "ip": "172.23.0.6",
            "manager": "9010b2027421",
            "version": "Wazuh v3.11.4",
            "node_name": "worker-1",
            "name": "3e42938763b6",
            "id": "002",
            "version": "Wazuh v3.12.3",
            "manager": "7995615e03c0"
         },
         {
            "os": {
               "arch": "x86_64",
               "major": "8",
               "minor": "1",
               "name": "CentOS Linux",
               "platform": "centos",
               "uname": "Linux |6df2b547e612 |5.3.0-40-generic |#32-Ubuntu SMP Fri Jan 31 20:24:34 UTC 2020 |x86_64",
               "version": "8.1"
            },
            "status": "Active",
            "group": [
               "default"
            ],
            "ip": "172.23.0.5",
            "manager": "f2fe0a2b2d94",
            "version": "Wazuh v3.11.4",
            "node_name": "master",
            "name": "6df2b547e612",
            "id": "001",
            "version": "Wazuh v3.12.3",
            "manager": "1cb46c820ff5"
         },
         {
            "os": {
               "arch": "x86_64",
               "major": "8",
               "minor": "1",
               "name": "CentOS Linux",
               "platform": "centos",
               "uname": "Linux |f2fe0a2b2d94 |5.3.0-40-generic |#32-Ubuntu SMP Fri Jan 31 20:24:34 UTC 2020 |x86_64",
               "version": "8.1"
            },
            "status": "Active",
            "ip": "127.0.0.1",
            "manager": "f2fe0a2b2d94",
            "version": "Wazuh v3.12.0",
            "node_name": "master",
            "name": "f2fe0a2b2d94",
            "id": "000",
            "version": "Wazuh v3.12.3",
            "manager": "1cb46c820ff5"
         },
         {
            "registerIP": "10.0.10.10",
            "name": "NewHost_2",
            "status": "Never connected",
            "dateAdd": "2019-08-30 09:31:03",
            "node_name": "unknown",
            "ip": "10.0.10.10",
            "id": "123"
         }
      ],
      "totalItems": 11
   }
}

Get an agent

Returns various information from an agent.

Request:

GET

/agents/:agent_id

Parameters:

Param	Type	Description
`agent_id`	Number	Agent ID.
`select`	String	List of selected fields separated by commas.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/agents/000?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "os": {
         "arch": "x86_64",
         "major": "8",
         "minor": "1",
         "name": "CentOS Linux",
         "platform": "centos",
         "uname": "Linux |f2fe0a2b2d94 |5.3.0-40-generic |#32-Ubuntu SMP Fri Jan 31 20:24:34 UTC 2020 |x86_64",
         "version": "8.1"
      },
      "status": "Active",
      "dateAdd": "2020-03-11 14:38:19",
      "registerIP": "127.0.0.1",
      "id": "000",
      "lastKeepAlive": "9999-12-31 23:59:59",
      "version": "Wazuh v3.12.0",
      "name": "f2fe0a2b2d94",
      "node_name": "master",
      "ip": "127.0.0.1",
      "lastKeepAlive": "9999-12-31 23:59:59",
      "version": "Wazuh v3.12.3",
      "id": "000",
      "node_name": "master"
   }
}

Get an agent by its name

Returns various information from an agent called :agent_name.

Request:

GET

/agents/name/:agent_name

Parameters:

Param	Type	Description
`agent_name`	String	Agent name.
`select`	String	List of selected fields separated by commas.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/agents/name/NewHost?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "id": "009",
      "status": "Never connected",
      "node_name": "unknown",
      "name": "NewHost",
      "dateAdd": "2020-03-11 14:41:58",
      "registerIP": "10.0.0.9",
      "ip": "10.0.0.9"
   }
}

Key

Get agent key

Returns the key of an agent.

Request:

GET

/agents/:agent_id/key

Parameters:

Param	Type	Description
`agent_id`	Number	Agent ID.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/agents/004/key?pretty"

Example Response:

{
   "error": 0,
   "data": "MDA0IHNlcnZlcjAwMSAxMC4wLjAuNjIgMzE2NmIxOGE3NDBmYTc4MmJhNDdhNDI0NzU2NjZkYWFlMGJmM2IzYzYwNTJmMjJlMmNmMDg2YzRjODI2MWRhYw=="
}

Restart

Restart a list of agents

Restarts a list of agents.

Request:

POST

/agents/restart

Parameters:

Param	Type	Description
`ids`	String[]	Array of agent ID's.

Example Request:

curl -u foo:bar -k -X POST -H "Content-Type:application/json" -d '{"ids":["002","004"]}' "https://127.0.0.1:55000/agents/restart?pretty"

Example Response:

{
    "error": 0,
    "data": {
        "msg": "All selected agents were restarted",
        "affected_agents": [
            "002",
            "004"
        ]
    }
}

Restart agents which belong to a group

Restarts agents which belong to a group

Request:

PUT

/agents/groups/:group_id/restart

Parameters:

Param	Type	Description
`Name`	String	of group

Example Request:

curl -u foo:bar -k -X PUT "https://127.0.0.1:55000/agents/groups/dmz/restart?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "msg": "All selected agents were restarted",
      "affected_agents": [
         "001",
         "002"
      ]
   }
}

Restart all agents

Restarts all agents.

Request:

PUT

/agents/restart

Example Request:

curl -u foo:bar -k -X PUT "https://127.0.0.1:55000/agents/restart?pretty"

Example Response:

{
    "error": 0,
    "data": "Restarting all agents"
}

Restart an agent

Restarts the specified agent.

Request:

PUT

/agents/:agent_id/restart

Parameters:

Param	Type	Description
`agent_id`	Number	Agent unique ID.

Example Request:

curl -u foo:bar -k -X PUT "https://127.0.0.1:55000/agents/007/restart?pretty"

Example Response:

{
    "error": 0,
    "data": {
        "msg": "All selected agents were restarted",
        "affected_agents": [
            "007"
        ]
    }
}

Stats

Get distinct fields in agents

Returns all the different combinations that agents have for the selected fields. It also indicates the total number of agents that have each combination.

Request:

GET

/agents/stats/distinct

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`fields`	String	List of fields affecting the operation.
`select`	String	List of selected fields separated by commas.
`q`	String	Query to filter result. For example q="status=Active"

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/agents/stats/distinct?pretty&fields=os.platform"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "os": {
               "platform": "centos"
            },
            "count": 4
         },
         {
            "count": 7
         }
      ],
      "totalItems": 11
   }
}

Upgrade

Get outdated agents

Returns the list of outdated agents.

Request:

GET

/agents/outdated

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`q`	String	Query to filter result. For example q="status=Active"

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/agents/outdated?pretty"

Example Response:

{
    "error": 0,
    "data": {
        "totalItems": 2,
        "items": [
            {
                "version": "Wazuh v3.0.0",
                "id": "003",
                "name": "main_database"
            },
            {
                "version": "Wazuh v3.0.0",
                "id": "004",
                "name": "dmz002"
            }
        ]
    }
}

Get upgrade result from agent

Returns the upgrade result from an agent.

Request:

GET

/agents/:agent_id/upgrade_result

Parameters:

Param	Type	Description
`agent_id`	Number	Agent ID.
`timeout`	Number	Seconds to wait for the agent to respond.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/agents/003/upgrade_result?pretty"

Example Response:

{
    "error": 0,
    "data": "Agent upgraded successfully"
}

Upgrade agent using custom file

Upgrade the agent using a custom file.

Request:

PUT

/agents/:agent_id/upgrade_custom

Parameters:

Param	Type	Description
`agent_id`	Number	Agent unique ID.
`file_path`	String	Path to the WPK file. The file must be on a folder on the Wazuh's installation directory (by default, <code>/var/ossec</code>).
`installer`	String	Installation script.

Example Request:

curl -u foo:bar -k -X PUT "https://127.0.0.1:55000/agents/002/upgrade_custom?pretty"

Example Response:

{
    "error": 0,
    "data": "Installation started"
}

Upgrade agent using online repository

Upgrade the agent using a WPK file from online repository.

Request:

PUT

/agents/:agent_id/upgrade

Parameters:

Param	Type	Description
`agent_id`	Number	Agent unique ID.
`wpk_repo`	String	WPK repository.
`version`	String	Wazuh version.
`use_http`	Boolean	Use protocol HTTP. If it is false use HTTPS. By default the value is set to false.
`force`	number	Force upgrade. Allowed values: 0 1

Example Request:

curl -u foo:bar -k -X PUT "https://127.0.0.1:55000/agents/002/upgrade?pretty"

Example Response:

{
    "error": 0,
    "data": "Upgrade procedure started"
}

Cache

Delete

Clear group cache

Clears cache of the specified group.

Request:

DELETE

/cache/:group

Parameters:

Param	Type	Description
`group`	String	cache group.

Example Request:

curl -u foo:bar -k -X DELETE "https://127.0.0.1:55000/cache/mygroup?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "all": [],
      "groups": {}
   }
}

Delete cache index

Clears entire cache.

Request:

DELETE

/cache

Example Request:

curl -u foo:bar -k -X DELETE "https://127.0.0.1:55000/cache?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "all": [],
      "groups": {}
   }
}

Info

Get cache index

Returns current cache index.

Request:

GET

/cache

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/cache?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "all": [],
      "groups": {}
   }
}

Return cache configuration

Returns cache configuration.

Request:

GET

/cache/config

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/cache/config?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "debug": false,
      "defaultDuration": 3600000,
      "enabled": false,
      "appendKey": [],
      "jsonp": false,
      "redisClient": false
   }
}

Ciscat

Results

Get CIS-CAT results from an agent

Returns the agent's ciscat results info

Request:

GET

/ciscat/:agent_id/results

Parameters:

Param	Type	Description
`agent_id`	Number	Agent ID.
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`select`	String	List of selected fields separated by commas.
`benchmark`	String	Filters by benchmark.
`profile`	String	Filters by evaluated profile.
`pass`	Number	Filters by passed checks.
`fail`	Number	Filters by failed checks.
`error`	Number	Filters by encountered errors.
`notchecked`	Number	Filters by not checked.
`unknown`	Number	Filters by unknown results.
`score`	Number	Filters by final score.
`q`	String	Advanced query filtering.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/ciscat/000/results?pretty&sort=-score"

Example Response:

{
    "error": 0,
    "data": {
        "totalItems": 2,
        "items": [
            {
                "profile": "xccdf_org.cisecurity.benchmarks_profile_Level_2_-_Server",
                "scan": {
                    "id": 1406741147,
                    "time": "2018-09-06T07:50:15.632-07:00"
                },
                "notchecked": 36,
                "pass": 104,
                "benchmark": "CIS Ubuntu Linux 16.04 LTS Benchmark",
                "unknown": 1,
                "score": 57,
                "error": 0,
                "fail": 79
            },
            {
                "profile": "xccdf_org.cisecurity.benchmarks_profile_Level_1_-_Workstation",
                "scan": {
                    "id": 1406741147,
                    "time": "2018-09-06T07:50:52.630-07:00"
                },
                "notchecked": 71,
                "pass": 96,
                "benchmark": "CIS Ubuntu Linux 16.04 LTS Benchmark",
                "unknown": 0,
                "score": 64,
                "error": 0,
                "fail": 53
            }
        ]
    }
}

Cluster

Configuration

Get active configuration in node node_id

Returns the requested configuration in JSON format.

Request:

GET

/cluster/:node_id/config/:component/:configuration

Parameters:

Param	Type	Description
`component`	String	Indicates the wazuh component to check. Allowed values: agent agentless analysis auth com csyslog integrator logcollector mail monitor request syscheck wmodules
`configuration`	String	Indicates a configuration to check in the component. Allowed values: client buffer labels internal agentless global active_response alerts command rules decoders internal auth active-response internal cluster csyslog integration localfile socket remote syscheck rootcheck wmodules

Param

Type

Description

component

String

Indicates the wazuh component to check.

Allowed values:

agent
agentless
analysis
auth
com
csyslog
integrator
logcollector
mail
monitor
request
syscheck
wmodules

configuration

String

Indicates a configuration to check in the component.

Allowed values:

client
buffer
labels
internal
agentless
global
active_response
alerts
command
rules
decoders
internal
auth
active-response
internal
cluster
csyslog
integration
localfile
socket
remote
syscheck
rootcheck
wmodules

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/cluster/master/config/logcollector/internal?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "internal": {
         "logcollector": {
            "remote_commands": 0,
            "loop_timeout": 2,
            "open_attempts": 8,
            "vcheck_files": 64,
            "max_lines": 10000,
            "max_files": 1000,
            "sock_fail_time": 300,
            "debug": 0,
            "sample_log_length": 64,
            "queue_size": 1024,
            "input_threads": 4,
            "force_reload": 0,
            "reload_interval": 64,
            "reload_delay": 1000,
            "rlimit_nofile": 1100
         }
      }
   }
}

Get node node_id's configuration

Returns ossec.conf in JSON format.

Request:

GET

/cluster/:node_id/configuration

Parameters:

Param	Type	Description
`section`	String	Indicates the ossec.conf section: global, rules, syscheck, rootcheck, remote, alerts, command, active-response, localfile.
`field`	String	Indicates a section child, e.g, fields for rule section are: include, decoder_dir, etc.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/cluster/worker-1/configuration?section=global&pretty"

Example Response:

{
   "error": 0,
   "data": {
      "jsonout_output": "yes",
      "alerts_log": "yes",
      "logall": "no",
      "logall_json": "no",
      "email_notification": "no",
      "smtp_server": "smtp.example.wazuh.com",
      "email_from": "wazuh@example.wazuh.com",
      "email_to": "recipient@example.wazuh.com",
      "email_maxperhour": "12",
      "email_log_source": "alerts.log",
      "white_list": [
         "127.0.0.1",
         "^localhost.localdomain$",
         "80.58.0.33",
         "80.58.32.97"
      ]
   }
}

Get the cluster configuration

Returns the cluster configuration

Request:

GET

/cluster/config

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/cluster/config?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "name": "wazuh",
      "node_name": "master",
      "node_type": "master",
      "key": "9d273b53510fef702b54a92e9cffc82e",
      "port": 1516,
      "bind_addr": "0.0.0.0",
      "nodes": [
         "wazuh-master"
      ],
      "hidden": "no",
      "disabled": false
   }
}

Files

Check Wazuh configuration in a cluster node

Returns if Wazuh configuration is OK.

Request:

GET

/cluster/:node_id/configuration/validation

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/cluster/master/configuration/validation?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "status": "OK"
   }
}

Check Wazuh configuration in all cluster nodes

Returns if Wazuh configuration is OK.

Request:

GET

/cluster/configuration/validation

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/cluster/configuration/validation?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "status": "OK"
   }
}

Delete a remote file in a cluster node

Confirmation message.

Request:

DELETE

/cluster/:node_id/files

Parameters:

Param	Type	Description
`path`	String	Relative path of file. This parameter is mandatory.

Example Request:

curl -u foo:bar -k -X DELETE "https://127.0.0.1:55000/cluster/master/files?path=etc/rules/local_rules.xml&pretty"

Example Response:

{
   "error": 0,
   "data": "File was deleted"
}

Get local file from any cluster node

Returns the content of a local file (rules, decoders and lists).

Request:

GET

/cluster/:node_id/files

Parameters:

Param	Type	Description
`path`	String	Relative path of file. This parameter is mandatory.
`validation`	Boolean	Validates the content of the file. An error will be returned if file content is not strictly correct. False by default.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/cluster/master/files?path=etc/decoders/local_decoder.xml&pretty"

Example Response:

{
   "error": 0,
   "data": "<!-- Local Decoders -->\n\n<!-- Modify it at your will. -->\n<!-- Copyright (C) 2015-2019, Wazuh Inc. -->\n\n<!--\n  - Allowed static fields:\n  - location   - where the log came from (only on FTS)\n  - srcuser    - extracts the source username\n  - dstuser    - extracts the destination (target) username\n  - user       - an alias to dstuser (only one of the two can be used)\n  - srcip      - source ip\n  - dstip      - dst ip\n  - srcport    - source port\n  - dstport    - destination port\n  - protocol   - protocol\n  - id         - event id\n  - url        - url of the event\n  - action     - event action (deny, drop, accept, etc)\n  - status     - event status (success, failure, etc)\n  - extra_data - Any extra data\n-->\n\n<decoder name=\"local_decoder_example\">\n    <program_name>local_decoder_example</program_name>\n</decoder>\n"
}

Update local file at any cluster node

Upload a local file (rules, decoders and lists) in a cluster node.

Request:

POST

/cluster/:node_id/files

Parameters:

Param	Type	Description
`file`	String	Input file.
`path`	String	Relative path were input file will be placed. This parameter is mandatory.
`overwrite`	Boolean	Replaces the existing file. False by default.

Example Request:

curl -u foo:bar -k -X POST -H 'Content-type: application/xml' -d @rules.xml "https://127.0.0.1:55000/cluster/master/files?path=etc/rules/local_rules.xml&pretty"

Example Response:

{
    "error": 0,
    "data": "File updated successfully"
}

Info

Get info about cluster status

Returns whether the cluster is enabled or disabled.

Request:

GET

/cluster/status

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/cluster/status?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "enabled": "yes",
      "running": "yes"
   }
}

Get node node_id's status

Returns the status of the manager processes.

Request:

GET

/cluster/:node_id/status

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/cluster/worker-1/status?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "ossec-agentlessd": "stopped",
      "ossec-analysisd": "running",
      "ossec-authd": "failed",
      "ossec-csyslogd": "stopped",
      "ossec-dbd": "stopped",
      "ossec-monitord": "running",
      "ossec-execd": "running",
      "ossec-integratord": "stopped",
      "ossec-logcollector": "running",
      "ossec-maild": "stopped",
      "ossec-remoted": "running",
      "ossec-reportd": "stopped",
      "ossec-syscheckd": "running",
      "wazuh-clusterd": "running",
      "wazuh-modulesd": "running",
      "wazuh-db": "running"
   }
}

Get node_id's information

Returns basic information about manager.

Request:

GET

/cluster/:node_id/info

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/cluster/worker-1/info?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "path": "/var/ossec",
      "version": "v3.12.3",
      "compilation_date": "Fri Aug 30 08:02:30 UTC 2019",
      "type": "server",
      "max_agents": "14000",
      "openssl_support": "yes",
      "ruleset_version": "31005",
      "tz_offset": "+0000",
      "tz_name": "UTC",
      "name": "9010b2027421",
      "cluster": {
         "enabled": "yes",
         "running": "yes",
         "name": "wazuh",
         "node_name": "worker-1",
         "node_type": "worker"
      }
   }
}

Show cluster health

Show cluster health.

Request:

GET

/cluster/healthcheck

Parameters:

Param	Type	Description
`node`	String	Filter information by node name.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/cluster/healthcheck?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "n_connected_nodes": 2,
      "nodes": {
         "worker-1": {
            "info": {
               "name": "worker-1",
               "type": "worker",
               "version": "3.12.3",
               "ip": "172.22.0.4",
               "n_active_agents": 1
            },
            "status": {
               "sync_integrity_free": true,
               "last_sync_integrity": {
                  "date_start_master": "2020-03-11 14:42:05.177044",
                  "date_end_master": "2020-03-11 14:42:05.277634",
                  "total_files": {
                     "missing": 6,
                     "extra": 0,
                     "extra_valid": 0,
                     "shared": 4
                  }
               },
               "sync_agentinfo_free": true,
               "last_sync_agentinfo": {
                  "date_start_master": "2020-03-11 14:42:08.062940",
                  "date_end_master": "2020-03-11 14:42:08.072203",
                  "total_agentinfo": 0,
                  "total_agent_info": 11
               },
               "sync_extravalid_free": true,
               "last_sync_agentgroups": {
                  "date_start_master": "2020-03-11 14:40:34.907258",
                  "date_end_master": "2020-03-11 14:40:34.919856",
                  "total_agentgroups": 0,
                  "total_extra_valid": 4
               },
               "last_keep_alive": "2020-03-11 14:42:07.821814"
            }
         },
         "worker-2": {
            "info": {
               "name": "worker-2",
               "type": "worker",
               "version": "3.12.3",
               "ip": "172.22.0.5",
               "n_active_agents": 0
            },
            "status": {
               "sync_integrity_free": true,
               "last_sync_integrity": {
                  "date_start_master": "2020-03-11 14:42:05.436777",
                  "date_end_master": "2020-03-11 14:42:05.542503",
                  "total_files": {
                     "missing": 6,
                     "extra": 0,
                     "extra_valid": 0,
                     "shared": 4
                  }
               },
               "sync_agentinfo_free": true,
               "last_sync_agentinfo": {
                  "date_start_master": "2020-03-11 14:42:08.293115",
                  "date_end_master": "2020-03-11 14:42:08.305542",
                  "total_agentinfo": 0,
                  "total_agent_info": 11
               },
               "sync_extravalid_free": true,
               "last_sync_agentgroups": {
                  "date_start_master": "2020-03-11 14:40:35.131238",
                  "date_end_master": "2020-03-11 14:40:35.139096",
                  "total_agentgroups": 0,
                  "total_extra_valid": 4
               },
               "last_keep_alive": "2020-03-11 14:42:08.017944"
            }
         },
         "master": {
            "info": {
               "name": "master",
               "type": "master",
               "version": "3.12.3",
               "ip": "wazuh-master",
               "n_active_agents": 2
            }
         }
      }
   }
}

Logs

Get ossec.log from a specific node in cluster.

Returns the three last months of ossec.log.

Request:

GET

/cluster/:node_id/logs

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`type_log`	String	Filters by type of log. Allowed values: all error warning info
`category`	String	Filters by category of log.
`q`	String	Query to filter results by. For example q="level=info"

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/cluster/worker-1/logs?offset=0&limit=5&pretty"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "timestamp": "2020-03-11 14:42:08",
            "tag": "wazuh-modulesd",
            "level": "warning",
            "description": " This vulnerability-detector declaration is deprecated. Use <vulnerability-detector> instead."
         },
         {
            "timestamp": "2020-03-11 14:42:08",
            "tag": "wazuh-modulesd",
            "level": "warning",
            "description": " 'disabled' option at module 'vulnerability-detector' is deprecated. Use 'enabled' instead."
         },
         {
            "timestamp": "2020-03-11 14:42:08",
            "tag": "wazuh-modulesd",
            "level": "warning",
            "description": " 'feed' option at module 'vulnerability-detector' is deprecated. Use 'provider' instead."
         },
         {
            "timestamp": "2020-03-11 14:42:08",
            "tag": "wazuh-modulesd",
            "level": "warning",
            "description": " 'feed' option at module 'vulnerability-detector' is deprecated. Use 'provider' instead."
         },
         {
            "timestamp": "2020-03-11 14:42:08",
            "tag": "wazuh-modulesd",
            "level": "warning",
            "description": " 'feed' option at module 'vulnerability-detector' is deprecated. Use 'provider' instead."
         }
      ],
      "totalItems": 185
   }
}

Get summary of ossec.log from a specific node in cluster.

Returns a summary of the last three months of the <code>ossec.log</code> file.

Request:

GET

/cluster/:node_id/logs/summary

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/cluster/worker-1/logs/summary?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "ossec-csyslogd": {
         "all": 2,
         "info": 2,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "ossec-dbd": {
         "all": 2,
         "info": 2,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "ossec-integratord": {
         "all": 2,
         "info": 2,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "ossec-agentlessd": {
         "all": 2,
         "info": 2,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "ossec-authd": {
         "all": 3,
         "info": 3,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "wazuh-db": {
         "all": 2,
         "info": 2,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "ossec-execd": {
         "all": 2,
         "info": 2,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "ossec-analysisd": {
         "all": 38,
         "info": 38,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "ossec-remoted": {
         "all": 14,
         "info": 10,
         "error": 0,
         "critical": 0,
         "warning": 4,
         "debug": 0
      },
      "ossec-logcollector": {
         "all": 12,
         "info": 11,
         "error": 1,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "ossec-monitord": {
         "all": 2,
         "info": 2,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "wazuh-modulesd": {
         "all": 17,
         "info": 2,
         "error": 0,
         "critical": 0,
         "warning": 15,
         "debug": 0
      },
      "wazuh-modulesd:oscap": {
         "all": 2,
         "info": 2,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "wazuh-modulesd:ciscat": {
         "all": 2,
         "info": 2,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "wazuh-modulesd:osquery": {
         "all": 2,
         "info": 2,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "wazuh-modulesd:syscollector": {
         "all": 5,
         "info": 5,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "sca": {
         "all": 13,
         "info": 13,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "wazuh-modulesd:database": {
         "all": 2,
         "info": 2,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "wazuh-modulesd:download": {
         "all": 2,
         "info": 2,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "wazuh-modulesd:control": {
         "all": 2,
         "info": 2,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "ossec-syscheckd": {
         "all": 53,
         "info": 53,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "ossec-rootcheck": {
         "all": 4,
         "info": 4,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      }
   }
}

Nodes

Get local node info

Returns the local node info.

Request:

GET

/cluster/node

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/cluster/node?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "node": "master",
      "cluster": "wazuh",
      "type": "master"
   }
}

Get node info

Returns the node info.

Request:

GET

/cluster/nodes/:node_name

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/cluster/nodes/master?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "name": "master",
      "type": "master",
      "version": "3.12.3",
      "ip": "wazuh-master"
   }
}

Get nodes info

Returns the nodes info.

Request:

GET

/cluster/nodes

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`select`	String	List of selected fields separated by commas.
`type`	String	Filters by node type.
`q`	String	Query to filter results by. For example q="name=worker-1"

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/cluster/nodes?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "totalItems": 3,
      "items": [
         {
            "name": "master",
            "type": "master",
            "version": "3.12.3",
            "ip": "wazuh-master"
         },
         {
            "name": "worker-1",
            "type": "worker",
            "version": "3.12.3",
            "ip": "172.22.0.4"
         },
         {
            "name": "worker-2",
            "type": "worker",
            "version": "3.12.3",
            "ip": "172.22.0.5"
         }
      ]
   }
}

Restart

Restart a specific node in cluster

Restarts a specific node in cluster.

Request:

PUT

/cluster/:node_id/restart

Example Request:

curl -u foo:bar -k -X PUT "https://127.0.0.1:55000/cluster/worker-1/restart?pretty"

Example Response:

{
    "error": 0,
    "data": "Restart request sent"
}

Restart all nodes in cluster

Restarts all nodes in cluster.

Request:

PUT

/cluster/restart

Example Request:

curl -u foo:bar -k -X PUT "https://127.0.0.1:55000/cluster/restart?pretty"

Example Response:

{
    "error": 0,
    "data": "Restart request sent"
}

Stats

Get node node_id's analysisd stats

Returns a summary of the current analysisd stats on the node.

Request:

GET

/cluster/:node_id/stats/analysisd

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/cluster/worker-1/stats/analysisd?pretty"

Example Response:

{
    "error": 0,
    "data": {
        "total_events_decoded": 10,
        "syscheck_events_decoded": 0,
        "syscheck_edps": 0,
        "syscollector_events_decoded": 0,
        "syscollector_edps": 0,
        "rootcheck_events_decoded": 0,
        "rootcheck_edps": 0,
        "sca_events_decoded": 0,
        "sca_edps": 0,
        "hostinfo_events_decoded": 0,
        "hostinfo_edps": 0,
        "winevt_events_decoded": 0,
        "winevt_edps": 0,
        "other_events_decoded": 10,
        "other_events_edps": 2,
        "events_processed": 10,
        "events_edps": 2,
        "events_received": 10,
        "events_dropped": 0,
        "alerts_written": 0,
        "firewall_written": 0,
        "fts_written": 0,
        "syscheck_queue_usage": 0,
        "syscheck_queue_size": 16384,
        "syscollector_queue_usage": 0,
        "syscollector_queue_size": 16384,
        "rootcheck_queue_usage": 0,
        "rootcheck_queue_size": 16384,
        "sca_queue_usage": 0,
        "sca_queue_size": 16384,
        "hostinfo_queue_usage": 0,
        "hostinfo_queue_size": 16384,
        "winevt_queue_usage": 0,
        "winevt_queue_size": 16384,
        "event_queue_usage": 0,
        "event_queue_size": 16384,
        "rule_matching_queue_usage": 0,
        "rule_matching_queue_size": 16384,
        "alerts_queue_usage": 0,
        "alerts_queue_size": 16384,
        "firewall_queue_usage": 0,
        "firewall_queue_size": 16384,
        "statistical_queue_usage": 0,
        "statistical_queue_size": 16384,
        "archives_queue_usage": 0,
        "archives_queue_size": 16384
    }
}

Get node node_id's remoted stats

Returns a summary of the current remoted stats on the node.

Request:

GET

/cluster/:node_id/stats/remoted

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/cluster/worker-1/stats/remoted?pretty"

Example Response:

{
    "error": 0,
    "data": {
        "queue_size": 0,
        "total_queue_size": 131072,
        "tcp_sessions": 0,
        "evt_count": 3435,
        "ctrl_msg_count": 81,
        "discarded_count": 0,
        "msg_sent": 1087,
        "recv_bytes": 1004678,
        "dequeued_after_close": 0
    }
}

Get node node_id's stats

Returns Wazuh statistical information for the current or specified date.

Request:

GET

/cluster/:node_id/stats

Parameters:

Param	Type	Description
`date`	String	Selects the date for getting the statistical information. Format: YYYYMMDD

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/cluster/worker-1/stats?pretty"

Example Response:

{
    "error": 0,
    "data": [
        {
            "hour": 5,
            "firewall": 0,
            "alerts": [
                {
                    "times": 4,
                    "sigid": 5715,
                    "level": 3
                },
                {
                    "times": 2,
                    "sigid": 1002,
                    "level": 2
                },
                {
                    "...": "..."
                }
            ],
            "totalAlerts": 107,
            "syscheck": 1257,
            "events": 1483
        },
        {
            "...": "..."
        }
    ]
}

Get node node_id's stats by hour

Returns Wazuh statistical information per hour. Each number in the averages field represents the average of alerts per hour.

Request:

GET

/cluster/:node_id/stats/hourly

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/cluster/worker-1/stats/hourly?pretty"

Example Response:

{
    "error": 0,
    "data": {
        "averages": [
            100,
            357,
            242,
            500,
            422,
            "...",
            123
        ],
        "interactions": 0
    }
}

Get node node_id's stats by week

Returns Wazuh statistical information per week. Each number in the hours field represents the average alerts per hour for that specific day.

Request:

GET

/cluster/:node_id/stats/weekly

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/cluster/worker-1/stats/weekly?pretty"

Example Response:

{
    "error": 0,
    "data": {
        "Wed": {
            "hours": [
                223,
                "...",
                456
            ],
            "interactions": 0
        },
        "Sun": {
            "hours": [
                332,
                "...",
                313
            ],
            "interactions": 0
        },
        "Fri": {
            "hours": [
                131,
                "...",
                432
            ],
            "interactions": 0
        },
        "Tue": {
            "hours": [
                536,
                "...",
                345
            ],
            "interactions": 0
        },
        "Mon": {
            "hours": [
                444,
                "...",
                556
            ],
            "interactions": 0
        },
        "Thu": {
            "hours": [
                888,
                "...",
                123
            ],
            "interactions": 0
        },
        "Sat": {
            "hours": [
                134,
                "...",
                995
            ],
            "interactions": 0
        }
    }
}

Decoders

Info

Get all decoders

Returns all decoders included in ossec.conf.

Request:

GET

/decoders

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`file`	String	Filters by filename.
`path`	String	Filters by path.
`status`	String	Filters the decoders by status. Allowed values: enabled disabled all
`q`	String	Query to filter results by. For example q=name=wazuh

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/decoders?pretty&offset=0&limit=2&sort=+file,position"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "file": "0005-wazuh_decoders.xml",
            "path": "ruleset/decoders",
            "name": "wazuh",
            "position": 0,
            "status": "enabled",
            "details": {
               "prematch": "^wazuh: "
            }
         },
         {
            "file": "0005-wazuh_decoders.xml",
            "path": "ruleset/decoders",
            "name": "agent-buffer",
            "position": 1,
            "status": "enabled",
            "details": {
               "parent": "wazuh",
               "prematch": "^Agent buffer:",
               "regex": "^ '(\\S+)'.",
               "order": "level"
            }
         }
      ],
      "totalItems": 880
   }
}

Get all decoders files

Returns all decoders files included in ossec.conf.

Request:

GET

/decoders/files

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`status`	String	Filters the decoders by status. Allowed values: enabled disabled all
`file`	String	Filters by filename.
`path`	String	Filters by path.
`download`	String	Name of the decoder file to download.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/decoders/files?pretty&offset=0&limit=10&sort=-path"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "file": "0065-cisco-ios_decoders.xml",
            "path": "ruleset/decoders",
            "status": "enabled"
         },
         {
            "file": "0240-pure-ftpd_decoders.xml",
            "path": "ruleset/decoders",
            "status": "enabled"
         },
         {
            "file": "0275-sendmail_decoders.xml",
            "path": "ruleset/decoders",
            "status": "enabled"
         },
         {
            "file": "0230-proftpd_decoders.xml",
            "path": "ruleset/decoders",
            "status": "enabled"
         },
         {
            "file": "0400-identity_guard_decoders.xml",
            "path": "ruleset/decoders",
            "status": "enabled"
         },
         {
            "file": "0051-checkpoint-smart1_decoders.xml",
            "path": "ruleset/decoders",
            "status": "enabled"
         },
         {
            "file": "0325-suhosin_decoders.xml",
            "path": "ruleset/decoders",
            "status": "enabled"
         },
         {
            "file": "0250-redis_decoders.xml",
            "path": "ruleset/decoders",
            "status": "enabled"
         },
         {
            "file": "0445-exim_decoders.xml",
            "path": "ruleset/decoders",
            "status": "enabled"
         },
         {
            "file": "0045-barracuda_decoders.xml",
            "path": "ruleset/decoders",
            "status": "enabled"
         }
      ],
      "totalItems": 101
   }
}

Get all parent decoders

Returns all parent decoders included in ossec.conf.

Request:

GET

/decoders/parents

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/decoders/parents?pretty&offset=0&limit=2&sort=-file"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "file": "local_decoder.xml",
            "path": "etc/decoders",
            "name": "local_decoder_example",
            "position": 0,
            "status": "enabled",
            "details": {
               "program_name": "local_decoder_example"
            }
         },
         {
            "file": "0480-perdition_decoders.xml",
            "path": "ruleset/decoders",
            "name": "perdition",
            "position": 0,
            "status": "enabled",
            "details": {
               "program_name": "^perdition"
            }
         }
      ],
      "totalItems": 160
   }
}

Get decoders by name

Returns the decoders with the specified name.

Request:

GET

/decoders/:decoder_name

Parameters:

Param	Type	Description
`decoder_name`	String	Decoder name.
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/decoders/apache-errorlog?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "file": "0025-apache_decoders.xml",
            "path": "ruleset/decoders",
            "name": "apache-errorlog",
            "position": 0,
            "status": "enabled",
            "details": {
               "program_name": "^apache2|^httpd"
            }
         },
         {
            "file": "0025-apache_decoders.xml",
            "path": "ruleset/decoders",
            "name": "apache-errorlog",
            "position": 1,
            "status": "enabled",
            "details": {
               "prematch": "^[warn] |^[notice] |^[error] "
            }
         },
         {
            "file": "0025-apache_decoders.xml",
            "path": "ruleset/decoders",
            "name": "apache-errorlog",
            "position": 2,
            "status": "enabled",
            "details": {
               "prematch": "^[\\w+ \\w+ \\d+ \\d+:\\d+:\\d+.\\d+ \\d+] [\\S+:warn] |^[\\w+ \\w+ \\d+ \\d+:\\d+:\\d+.\\d+ \\d+] [\\S+:notice] |^[\\w+ \\w+ \\d+ \\d+:\\d+:\\d+.\\d+ \\d+] [\\S*:error] |^[\\w+ \\w+ \\d+ \\d+:\\d+:\\d+.\\d+ \\d+] [\\S+:info] "
            }
         }
      ],
      "totalItems": 3
   }
}

Experimental

Clear

Clear syscheck database

Clears the syscheck database for all agents.

Request:

DELETE

/experimental/syscheck

Example Request:

curl -u foo:bar -k -X DELETE "https://127.0.0.1:55000/experimental/syscheck?pretty"

Example Response:

{
    "error": 0,
    "data": "Syscheck database deleted"
}

Hardware

Get hardware info of all agents

Returns the agent's hardware info.

Request:

GET

/experimental/syscollector/hardware

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`select`	String	List of selected fields separated by commas.
`ram_free`	String	Filters by ram_free.
`ram_total`	String	Filters by ram_total.
`cpu_cores`	String	Filters by cpu_cores.
`cpu_mhz`	String	Filters by cpu_mhz.
`cpu_name`	String	Filters by cpu_name.
`board_serial`	String	Filters by board_serial.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/experimental/syscollector/hardware?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "cpu": {
               "cores": 8,
               "mhz": 2308.682,
               "name": "Intel(R) Core(TM) i5-9300H CPU @ 2.40GHz"
            },
            "ram": {
               "free": 585788,
               "total": 16024656,
               "usage": 97
            },
            "scan": {
               "id": 900301359,
               "time": "2020/03/11 14:40:08"
            },
            "board_serial": "/72NL9Y2/CNCMK009B30174/",
            "agent_id": "000"
         },
         {
            "cpu": {
               "cores": 4,
               "mhz": 3534.378,
               "name": "Intel(R) Core(TM) i5-9300H CPU @ 2.40GHz"
            },
            "ram": {
               "free": 561428,
               "total": 16024656,
               "usage": 97
            },
            "scan": {
               "id": 7297918,
               "time": "2020/03/11 14:41:26"
            },
            "board_serial": "/72NL9Y2/CNCMK009B30174/",
            "agent_id": "003"
         },
         {
            "cpu": {
               "cores": 8,
               "mhz": 1135.028,
               "name": "Intel(R) Core(TM) i5-9300H CPU @ 2.40GHz"
            },
            "ram": {
               "free": 577132,
               "total": 16024656,
               "usage": 97
            },
            "scan": {
               "id": 727206569,
               "time": "2020/03/11 14:40:08"
            },
            "board_serial": "/72NL9Y2/CNCMK009B30174/",
            "agent_id": "000"
         },
         {
            "cpu": {
               "cores": 8,
               "mhz": 1416.754,
               "name": "Intel(R) Core(TM) i5-9300H CPU @ 2.40GHz"
            },
            "ram": {
               "free": 559936,
               "total": 16024656,
               "usage": 97
            },
            "scan": {
               "id": 728438524,
               "time": "2020/03/11 14:41:09"
            },
            "board_serial": "/72NL9Y2/CNCMK009B30174/",
            "agent_id": "002"
         },
         {
            "cpu": {
               "cores": 8,
               "mhz": 3460.966,
               "name": "Intel(R) Core(TM) i5-9300H CPU @ 2.40GHz"
            },
            "ram": {
               "free": 598588,
               "total": 16024656,
               "usage": 97
            },
            "scan": {
               "id": 1787159141,
               "time": "2020/03/11 14:40:08"
            },
            "board_serial": "/72NL9Y2/CNCMK009B30174/",
            "agent_id": "000"
         },
         {
            "cpu": {
               "cores": 8,
               "mhz": 900.009,
               "name": "Intel(R) Core(TM) i5-9300H CPU @ 2.40GHz"
            },
            "ram": {
               "free": 551276,
               "total": 16024656,
               "usage": 97
            },
            "scan": {
               "id": 1318139746,
               "time": "2020/03/11 14:40:59"
            },
            "board_serial": "/72NL9Y2/CNCMK009B30174/",
            "agent_id": "001"
         }
      ],
      "totalItems": 8
   }
}

Netaddr

Get network address info of all agents

Returns the agent's network address info.

Request:

GET

/experimental/syscollector/netaddr

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`select`	String	List of selected fields separated by commas.
`proto`	String	Filters by proto.
`address`	String	Filters by address.
`broadcast`	String	Filters by broadcast.
`netmask`	String	Filters by netmask.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/experimental/syscollector/netaddr?pretty&limit=2&sort=proto"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "scan": {
               "id": 322964060
            },
            "broadcast": "172.23.255.255",
            "iface": "eth0",
            "address": "172.23.0.4",
            "proto": "ipv4",
            "netmask": "255.255.0.0",
            "agent_id": "000"
         },
         {
            "scan": {
               "id": 1643886297
            },
            "broadcast": "172.23.255.255",
            "iface": "eth0",
            "address": "172.23.0.7",
            "proto": "ipv4",
            "netmask": "255.255.0.0",
            "agent_id": "003"
         }
      ],
      "totalItems": 8
   }
}

Netiface

Get network interface info of all agents

Returns the agent's network interface info.

Request:

GET

/experimental/syscollector/netiface

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`select`	String	List of selected fields separated by commas.
`name`	String	Filters by name.
`adapter`	String	Filters by adapter.
`type`	String	Filters by type.
`state`	String	Filters by state.
`mtu`	String	Filters by mtu.
`tx_packets`	String	Filters by tx_packets.
`rx_packets`	String	Filters by rx_packets.
`tx_bytes`	String	Filters by tx_bytes.
`rx_bytes`	String	Filters by rx_bytes.
`tx_errors`	String	Filters by tx_errors.
`rx_errors`	String	Filters by rx_errors.
`tx_dropped`	String	Filters by tx_dropped.
`rx_dropped`	String	Filters by rx_dropped.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/experimental/syscollector/netiface?pretty&limit=2"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "rx": {
               "bytes": 7414,
               "dropped": 0,
               "errors": 0,
               "packets": 52
            },
            "scan": {
               "id": 322964060,
               "time": "2020/03/11 14:40:08"
            },
            "tx": {
               "bytes": 454,
               "dropped": 0,
               "errors": 0,
               "packets": 5
            },
            "mtu": 1500,
            "type": "ethernet",
            "state": "up",
            "mac": "02:42:ac:17:00:04",
            "name": "eth0",
            "agent_id": "000"
         },
         {
            "rx": {
               "bytes": 448082,
               "dropped": 0,
               "errors": 0,
               "packets": 1085
            },
            "scan": {
               "id": 1643886297,
               "time": "2020/03/11 14:41:11"
            },
            "tx": {
               "bytes": 421937,
               "dropped": 0,
               "errors": 0,
               "packets": 1630
            },
            "mtu": 1500,
            "type": "ethernet",
            "state": "up",
            "mac": "02:42:AC:17:00:07",
            "name": "eth0",
            "agent_id": "003"
         }
      ],
      "totalItems": 8
   }
}

Netproto

Get network protocol info of all agents

Returns the agent's network protocol info.

Request:

GET

/experimental/syscollector/netproto

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`select`	String	List of selected fields separated by commas.
`search`	String	Looks for elements with the specified string.
`iface`	String	Filters by iface.
`type`	String	Filters by type.
`gateway`	String	Filters by gateway.
`dhcp`	String	Filters by dhcp.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/experimental/syscollector/netproto?pretty&limit=2&sort=type"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "scan": {
               "id": 322964060
            },
            "gateway": "172.23.0.1",
            "iface": "eth0",
            "dhcp": "enabled",
            "type": "ipv4",
            "agent_id": "000"
         },
         {
            "scan": {
               "id": 1643886297
            },
            "gateway": "172.23.0.1",
            "iface": "eth0",
            "dhcp": "enabled",
            "type": "ipv4",
            "agent_id": "003"
         }
      ],
      "totalItems": 8
   }
}

OS

Get os info of all agents

Returns the agent's os info.

Request:

GET

/experimental/syscollector/os

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`select`	String	List of selected fields separated by commas.
`os_name`	String	Filters by os_name.
`architecture`	String	Filters by architecture.
`os_version`	String	Filters by os_version.
`version`	String	Filters by version.
`release`	String	Filters by release.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/experimental/syscollector/os?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "os": {
               "major": "8",
               "minor": "1",
               "name": "CentOS Linux",
               "platform": "centos",
               "version": "8.1"
            },
            "scan": {
               "id": 556912922,
               "time": "2020/03/11 14:40:08"
            },
            "release": "5.3.0-40-generic",
            "hostname": "7ce87f29a3ad",
            "version": "#32-Ubuntu SMP Fri Jan 31 20:24:34 UTC 2020",
            "architecture": "x86_64",
            "sysname": "Linux",
            "agent_id": "000"
         },
         {
            "os": {
               "codename": "Core",
               "major": "8",
               "name": "CentOS Linux",
               "platform": "centos",
               "version": "8 (Core)"
            },
            "scan": {
               "id": 850046217,
               "time": "2020/03/11 14:41:26"
            },
            "release": "5.3.0-40-generic",
            "hostname": "51ae6aeff9b0",
            "version": "#32-Ubuntu SMP Fri Jan 31 20:24:34 UTC 2020",
            "architecture": "x86_64",
            "sysname": "Linux",
            "agent_id": "003"
         },
         {
            "os": {
               "major": "8",
               "minor": "1",
               "name": "CentOS Linux",
               "platform": "centos",
               "version": "8.1"
            },
            "scan": {
               "id": 323895753,
               "time": "2020/03/11 14:40:08"
            },
            "sysname": "Linux",
            "release": "5.3.0-40-generic",
            "architecture": "x86_64",
            "version": "#32-Ubuntu SMP Fri Jan 31 20:24:34 UTC 2020",
            "hostname": "9010b2027421",
            "agent_id": "000"
         },
         {
            "os": {
               "major": "8",
               "minor": "1",
               "name": "CentOS Linux",
               "platform": "centos",
               "version": "8.1"
            },
            "scan": {
               "id": 1270222934,
               "time": "2020/03/11 14:41:09"
            },
            "sysname": "Linux",
            "release": "5.3.0-40-generic",
            "architecture": "x86_64",
            "version": "#32-Ubuntu SMP Fri Jan 31 20:24:34 UTC 2020",
            "hostname": "3e42938763b6",
            "agent_id": "002"
         },
         {
            "os": {
               "major": "8",
               "minor": "1",
               "name": "CentOS Linux",
               "platform": "centos",
               "version": "8.1"
            },
            "scan": {
               "id": 1128899975,
               "time": "2020/03/11 14:40:08"
            },
            "sysname": "Linux",
            "version": "#32-Ubuntu SMP Fri Jan 31 20:24:34 UTC 2020",
            "release": "5.3.0-40-generic",
            "hostname": "f2fe0a2b2d94",
            "architecture": "x86_64",
            "agent_id": "000"
         },
         {
            "os": {
               "major": "8",
               "minor": "1",
               "name": "CentOS Linux",
               "platform": "centos",
               "version": "8.1"
            },
            "scan": {
               "id": 1198650764,
               "time": "2020/03/11 14:40:59"
            },
            "sysname": "Linux",
            "version": "#32-Ubuntu SMP Fri Jan 31 20:24:34 UTC 2020",
            "release": "5.3.0-40-generic",
            "hostname": "6df2b547e612",
            "architecture": "x86_64",
            "agent_id": "001"
         }
      ],
      "totalItems": 8
   }
}

Packages

Get packages info of all agents

Returns the agent's packages info.

Request:

GET

/experimental/syscollector/packages

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`vendor`	String	Filters by vendor.
`name`	String	Filters by name.
`architecture`	String	Filters by architecture.
`format`	String	Filters by format.
`select`	String	List of selected fields separated by commas.
`version`	String	Filter by version name.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/experimental/syscollector/packages?pretty&sort=-name&limit=2"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "scan": {
               "id": 1892036290,
               "time": "2020/03/11 14:40:08"
            },
            "install_time": "2020/03/11 14:39:53",
            "version": "5.5.1-6.el8",
            "name": "zsh",
            "format": "rpm",
            "description": "Powerful interactive shell",
            "size": 7099,
            "vendor": "CentOS",
            "section": "Unspecified",
            "architecture": "x86_64",
            "agent_id": "000"
         },
         {
            "scan": {
               "id": 1570416077,
               "time": "2020/03/11 14:40:08"
            },
            "format": "rpm",
            "name": "zsh",
            "section": "Unspecified",
            "size": 7099,
            "install_time": "2020/03/11 14:39:53",
            "architecture": "x86_64",
            "description": "Powerful interactive shell",
            "version": "5.5.1-6.el8",
            "vendor": "CentOS",
            "agent_id": "000"
         }
      ],
      "totalItems": 1744
   }
}

Ports

Get ports info of all agents

Returns the agent's ports info.

Request:

GET

/experimental/syscollector/ports

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`select`	String	List of selected fields separated by commas.
`pid`	Number	Filters by pid.
`protocol`	String	Filters by protocol.
`local_ip`	String	Filters by local_ip.
`local_port`	Number	Filters by local_port.
`remote_ip`	String	Filters by remote_ip.
`tx_queue`	Number	Filters by tx_queue.
`state`	String	Filters by state.
`process`	String	Filters by process.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/experimental/syscollector/ports?pretty&limit=2&sort=protocol"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "local": {
               "ip": "127.0.0.11",
               "port": 45491
            },
            "remote": {
               "ip": "0.0.0.0",
               "port": 0
            },
            "scan": {
               "id": 99092781,
               "time": "2020/03/11 14:40:11"
            },
            "protocol": "tcp",
            "inode": 13036496,
            "rx_queue": 0,
            "state": "listening",
            "tx_queue": 0,
            "agent_id": "000"
         },
         {
            "local": {
               "ip": "0.0.0.0",
               "port": 22
            },
            "remote": {
               "ip": "0.0.0.0",
               "port": 0
            },
            "scan": {
               "id": 99092781,
               "time": "2020/03/11 14:40:11"
            },
            "protocol": "tcp",
            "inode": 13040604,
            "rx_queue": 0,
            "state": "listening",
            "tx_queue": 0,
            "agent_id": "000"
         }
      ],
      "totalItems": 24
   }
}

Processes

Get processes info of all agents

Returns the agent's processes info.

Request:

GET

/experimental/syscollector/processes

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`select`	String	List of selected fields separated by commas.
`pid`	Number	Filters by process pid.
`state`	String	Filters by process state.
`ppid`	Number	Filters by process parent pid.
`egroup`	String	Filters by process egroup.
`euser`	String	Filters by process euser.
`fgroup`	String	Filters by process fgroup.
`name`	String	Filters by process name.
`nlwp`	Number	Filters by process nlwp.
`pgrp`	Number	Filters by process pgrp.
`priority`	Number	Filters by process priority.
`rgroup`	String	Filters by process rgroup.
`ruser`	String	Filters by process ruser.
`sgroup`	String	Filters by process sgroup.
`suser`	String	Filters by process suser.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/experimental/syscollector/processes?pretty&limit=2&sort=priority"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "scan": {
               "id": 818705997,
               "time": "2020/03/11 14:40:11"
            },
            "euser": "root",
            "pid": "1",
            "stime": 2,
            "sgroup": "root",
            "size": 2972,
            "suser": "root",
            "share": 631,
            "session": 1,
            "state": "S",
            "priority": 20,
            "processor": 4,
            "ruser": "root",
            "cmd": "bash",
            "utime": 21,
            "ppid": 0,
            "rgroup": "root",
            "nlwp": 1,
            "name": "bash",
            "fgroup": "root",
            "pgrp": 1,
            "start_time": 2748050,
            "argvs": "/scripts/entrypoint.sh,wazuh-master,worker-2,worker",
            "resident": 695,
            "vm_size": 11888,
            "egroup": "root",
            "tgid": 1,
            "nice": 0,
            "tty": 0,
            "agent_id": "000"
         },
         {
            "scan": {
               "id": 818705997,
               "time": "2020/03/11 14:40:11"
            },
            "euser": "ossec",
            "pid": "136",
            "stime": 5,
            "sgroup": "ossec",
            "size": 159245,
            "suser": "ossec",
            "share": 1008,
            "session": 135,
            "state": "S",
            "priority": 20,
            "processor": 3,
            "ruser": "ossec",
            "cmd": "/var/ossec/bin/wazuh-db",
            "utime": 4,
            "ppid": 1,
            "rgroup": "ossec",
            "nlwp": 11,
            "name": "wazuh-db",
            "fgroup": "ossec",
            "pgrp": 135,
            "start_time": 2748314,
            "resident": 1335,
            "vm_size": 636980,
            "egroup": "ossec",
            "tgid": 136,
            "nice": 0,
            "tty": 0,
            "agent_id": "000"
         }
      ],
      "totalItems": 91
   }
}

Results

Get CIS-CAT results

Returns the agent's ciscat results info.

Request:

GET

/experimental/ciscat/results

Parameters:

Param	Type	Description
`agent_id`	Number	Agent ID.
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`select`	String	List of selected fields separated by commas.
`benchmark`	String	Filters by benchmark.
`profile`	String	Filters by evaluated profile.
`pass`	Number	Filters by passed checks.
`fail`	Number	Filters by failed checks.
`error`	Number	Filters by encountered errors.
`notchecked`	Number	Filters by not checked.
`unknown`	Number	Filters by unknown results.
`score`	Number	Filters by final score.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/experimental/ciscat/results?pretty&sort=-score"

Example Response:

{
    "error": 0,
    "data": {
        "totalItems": 2,
        "items": [
            {
                "profile": "xccdf_org.cisecurity.benchmarks_profile_Level_1_-_Workstation",
                "scan": {
                    "id": 1260865673,
                    "time": "2018-09-06T07:59:25.682-07:00"
                },
                "notchecked": 71,
                "pass": 96,
                "benchmark": "CIS Ubuntu Linux 16.04 LTS Benchmark",
                "unknown": 0,
                "score": 64,
                "agent_id": "001",
                "error": 0,
                "fail": 53
            },
            {
                "profile": "xccdf_org.cisecurity.benchmarks_profile_Level_2_-_Server",
                "scan": {
                    "id": 1260865673,
                    "time": "2018-09-06T07:58:39.342-07:00"
                },
                "notchecked": 36,
                "pass": 104,
                "benchmark": "CIS Ubuntu Linux 16.04 LTS Benchmark",
                "unknown": 1,
                "score": 57,
                "agent_id": "001",
                "error": 0,
                "fail": 79
            }
        ]
    }
}

Lists

Info

Get all lists

Returns the content of all CDB lists.

Request:

GET

/lists

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`path`	String	Filters by path.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/lists?pretty&path=etc/lists/audit-keys"

Example Response:

{
   "error": 0,
   "data": {
      "totalItems": 1,
      "items": [
         [
            {
               "key": "audit-wazuh-w",
               "value": "write"
            },
            {
               "key": "audit-wazuh-r",
               "value": "read"
            },
            {
               "key": "audit-wazuh-a",
               "value": "attribute"
            },
            {
               "key": "audit-wazuh-x",
               "value": "execute"
            },
            {
               "key": "audit-wazuh-c",
               "value": "command"
            }
         ]
      ]
   }
}

Get paths from all lists

Returns the path from all lists.

Request:

GET

/lists/files

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/lists/files?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "totalItems": 4,
      "items": [
         {
            "path": "etc/lists",
            "name": "audit-keys"
         },
         {
            "path": "etc/lists",
            "name": "security-eventchannel"
         },
         {
            "path": "etc/lists/amazon",
            "name": "aws-eventnames"
         },
         {
            "path": "etc/lists/amazon",
            "name": "aws-sources"
         }
      ]
   }
}

Manager

Configuration

Get manager active configuration

Returns the requested configuration in JSON format.

Request:

GET

/manager/config/:component/:configuration

Parameters:

Param

Type

Description

component

String

Indicates the wazuh component to check.

Allowed values:

agent
agentless
analysis
auth
com
csyslog
integrator
logcollector
mail
monitor
request
syscheck
wmodules

configuration

String

Indicates a configuration to check in the component.

Allowed values:

client
buffer
labels
internal
agentless
global
active_response
alerts
command
rules
decoders
internal
auth
active-response
internal
cluster
csyslog
integration
localfile
socket
remote
syscheck
rootcheck
wmodules

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/manager/config/logcollector/internal?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "internal": {
         "logcollector": {
            "remote_commands": 0,
            "loop_timeout": 2,
            "open_attempts": 8,
            "vcheck_files": 64,
            "max_lines": 10000,
            "max_files": 1000,
            "sock_fail_time": 300,
            "debug": 0,
            "sample_log_length": 64,
            "queue_size": 1024,
            "input_threads": 4,
            "force_reload": 0,
            "reload_interval": 64,
            "reload_delay": 1000,
            "rlimit_nofile": 1100
         }
      }
   }
}

Get manager configuration

Returns ossec.conf in JSON format.

Request:

GET

/manager/configuration

Parameters:

Param	Type	Description
`section`	String	Indicates the ossec.conf section: global, rules, syscheck, rootcheck, remote, alerts, command, active-response, localfile.
`field`	String	Indicates a section child, e.g, fields for rule section are: include, decoder_dir, etc.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/manager/configuration?section=global&pretty"

Example Response:

{
   "error": 0,
   "data": {
      "jsonout_output": "yes",
      "alerts_log": "yes",
      "logall": "no",
      "logall_json": "no",
      "email_notification": "yes",
      "smtp_server": "localhost",
      "email_from": "wazuh@test.com",
      "email_to": "recipient@example.wazuh.com",
      "email_maxperhour": "12",
      "email_log_source": "alerts.log",
      "white_list": [
         "127.0.0.1",
         "^localhost.localdomain$",
         "80.58.0.33",
         "80.58.32.97"
      ]
   }
}

Files

Check Wazuh configuration

Returns if Wazuh configuration is OK.

Request:

GET

/manager/configuration/validation

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/manager/configuration/validation?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "status": "OK"
   }
}

Delete a local file

Confirmation message.

Request:

DELETE

/manager/files

Parameters:

Param	Type	Description
`path`	String	Relative path of file. This parameter is mandatory.

Example Request:

curl -u foo:bar -k -X DELETE "https://127.0.0.1:55000/manager/files?path=etc/rules/local_rules.xml&pretty"

Example Response:

{
   "error": 1906,
   "message": "File does not exist"
}

Get local file

Returns the content of a local file (rules, decoders and lists).

Request:

GET

/manager/files

Parameters:

Param	Type	Description
`path`	String	Relative path of file. This parameter is mandatory.
`validation`	Boolean	Validates the content of the file. An error will be returned if file content is not strictly correct. False by default.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/manager/files?path=etc/decoders/local_decoder.xml&pretty"

Example Response:

{
   "error": 0,
   "data": "<!-- Local Decoders -->\n\n<!-- Modify it at your will. -->\n<!-- Copyright (C) 2015-2019, Wazuh Inc. -->\n\n<!--\n  - Allowed static fields:\n  - location   - where the log came from (only on FTS)\n  - srcuser    - extracts the source username\n  - dstuser    - extracts the destination (target) username\n  - user       - an alias to dstuser (only one of the two can be used)\n  - srcip      - source ip\n  - dstip      - dst ip\n  - srcport    - source port\n  - dstport    - destination port\n  - protocol   - protocol\n  - id         - event id\n  - url        - url of the event\n  - action     - event action (deny, drop, accept, etc)\n  - status     - event status (success, failure, etc)\n  - extra_data - Any extra data\n-->\n\n<decoder name=\"local_decoder_example\">\n    <program_name>local_decoder_example</program_name>\n</decoder>\n"
}

Update local file

Upload a local file (rules, decoders and lists).

Request:

POST

/manager/files

Parameters:

Param	Type	Description
`file`	String	Input file.
`path`	String	Relative path were input file will be placed. This parameter is mandatory.
`overwrite`	Boolean	Replaces the existing file. False by default.

Example Request:

curl -u foo:bar -k -X POST -H 'Content-type: application/xml' -d @rules.xml "https://127.0.0.1:55000/manager/files?path=etc/rules/new_rule.xml&pretty"

Example Response:

{
    "error": 0,
    "data": "File updated successfully"
}

Info

Get manager information

Returns basic information about manager.

Request:

GET

/manager/info

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/manager/info?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "path": "/var/ossec",
      "version": "v3.12.3",
      "compilation_date": "Fri Aug 30 08:02:30 UTC 2019",
      "type": "server",
      "max_agents": "N/A",
      "openssl_support": "N/A",
      "ruleset_version": "31200",
      "tz_offset": "+0000",
      "tz_name": "UTC",
      "name": "f2fe0a2b2d94",
      "cluster": {
         "enabled": "yes",
         "running": "yes",
         "name": "wazuh",
         "node_name": "master",
         "node_type": "master"
      }
   }
}

Get manager status

Returns the status of the manager processes.

Request:

GET

/manager/status

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/manager/status?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "ossec-agentlessd": "running",
      "ossec-analysisd": "running",
      "ossec-authd": "running",
      "ossec-csyslogd": "running",
      "ossec-dbd": "stopped",
      "ossec-monitord": "running",
      "ossec-execd": "running",
      "ossec-integratord": "running",
      "ossec-logcollector": "running",
      "ossec-maild": "running",
      "ossec-remoted": "running",
      "ossec-reportd": "stopped",
      "ossec-syscheckd": "running",
      "wazuh-clusterd": "running",
      "wazuh-modulesd": "running",
      "wazuh-db": "running"
   }
}

Logs

Get ossec.log

Returns the three last months of ossec.log.

Request:

GET

/manager/logs

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`type_log`	String	Filters by type of log. Allowed values: all error warning info
`category`	String	Filters by category of log.
`q`	String	Query to filter results by. For example q="level=info"

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/manager/logs?offset=0&limit=5&pretty"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "timestamp": "2020-03-11 14:42:18",
            "tag": "wazuh-modulesd",
            "level": "warning",
            "description": " This vulnerability-detector declaration is deprecated. Use <vulnerability-detector> instead."
         },
         {
            "timestamp": "2020-03-11 14:42:18",
            "tag": "wazuh-modulesd",
            "level": "warning",
            "description": " 'disabled' option at module 'vulnerability-detector' is deprecated. Use 'enabled' instead."
         },
         {
            "timestamp": "2020-03-11 14:42:18",
            "tag": "wazuh-modulesd",
            "level": "warning",
            "description": " 'feed' option at module 'vulnerability-detector' is deprecated. Use 'provider' instead."
         },
         {
            "timestamp": "2020-03-11 14:42:18",
            "tag": "wazuh-modulesd",
            "level": "warning",
            "description": " 'feed' option at module 'vulnerability-detector' is deprecated. Use 'provider' instead."
         },
         {
            "timestamp": "2020-03-11 14:42:18",
            "tag": "wazuh-modulesd",
            "level": "warning",
            "description": " 'feed' option at module 'vulnerability-detector' is deprecated. Use 'provider' instead."
         }
      ],
      "totalItems": 230
   }
}

Get summary of ossec.log

Returns a summary of the last three months of the <code>ossec.log</code> file.

Request:

GET

/manager/logs/summary

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/manager/logs/summary?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "ossec-csyslogd": {
         "all": 3,
         "info": 3,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "ossec-dbd": {
         "all": 2,
         "info": 2,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "ossec-integratord": {
         "all": 3,
         "info": 3,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "ossec-agentlessd": {
         "all": 4,
         "info": 2,
         "error": 2,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "ossec-authd": {
         "all": 24,
         "info": 24,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "wazuh-db": {
         "all": 2,
         "info": 2,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "ossec-execd": {
         "all": 2,
         "info": 2,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "ossec-analysisd": {
         "all": 45,
         "info": 45,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "ossec-remoted": {
         "all": 15,
         "info": 12,
         "error": 0,
         "critical": 0,
         "warning": 3,
         "debug": 0
      },
      "ossec-logcollector": {
         "all": 12,
         "info": 11,
         "error": 1,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "ossec-monitord": {
         "all": 2,
         "info": 2,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "wazuh-modulesd": {
         "all": 27,
         "info": 2,
         "error": 0,
         "critical": 0,
         "warning": 25,
         "debug": 0
      },
      "wazuh-modulesd:oscap": {
         "all": 2,
         "info": 2,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "wazuh-modulesd:ciscat": {
         "all": 2,
         "info": 2,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "wazuh-modulesd:osquery": {
         "all": 2,
         "info": 2,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "wazuh-modulesd:syscollector": {
         "all": 5,
         "info": 5,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "sca": {
         "all": 13,
         "info": 13,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "wazuh-modulesd:database": {
         "all": 2,
         "info": 2,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "wazuh-modulesd:download": {
         "all": 2,
         "info": 2,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "wazuh-modulesd:control": {
         "all": 2,
         "info": 2,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "ossec-syscheckd": {
         "all": 53,
         "info": 53,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "ossec-rootcheck": {
         "all": 4,
         "info": 4,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      },
      "ossec-maild": {
         "all": 2,
         "info": 2,
         "error": 0,
         "critical": 0,
         "warning": 0,
         "debug": 0
      }
   }
}

Restart

Restart Wazuh manager

Restarts Wazuh Manager.

Request:

PUT

/manager/restart

Example Request:

curl -u foo:bar -k -X PUT "https://127.0.0.1:55000/manager/restart?pretty"

Example Response:

{
    "error": 0,
    "data": "Restart request sent"
}

Stats

Get analysisd stats

Returns a summary of the current analysisd stats.

Request:

GET

/manager/stats/analysisd

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/manager/stats/analysisd?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "total_events_decoded": 5,
      "syscheck_events_decoded": 0,
      "syscheck_edps": 0,
      "syscollector_events_decoded": 0,
      "syscollector_edps": 0,
      "rootcheck_events_decoded": 0,
      "rootcheck_edps": 0,
      "sca_events_decoded": 0,
      "sca_edps": 0,
      "hostinfo_events_decoded": 0,
      "hostinfo_edps": 0,
      "winevt_events_decoded": 0,
      "winevt_edps": 0,
      "other_events_decoded": 5,
      "other_events_edps": 1,
      "events_processed": 5,
      "events_edps": 1,
      "events_received": 5,
      "events_dropped": 0,
      "alerts_written": 0,
      "firewall_written": 0,
      "fts_written": 0,
      "syscheck_queue_usage": 0,
      "syscheck_queue_size": 16384,
      "syscollector_queue_usage": 0,
      "syscollector_queue_size": 16384,
      "rootcheck_queue_usage": 0,
      "rootcheck_queue_size": 16384,
      "sca_queue_usage": 0,
      "sca_queue_size": 16384,
      "hostinfo_queue_usage": 0,
      "hostinfo_queue_size": 16384,
      "winevt_queue_usage": 0,
      "winevt_queue_size": 16384,
      "event_queue_usage": 0,
      "event_queue_size": 16384,
      "rule_matching_queue_usage": 0,
      "rule_matching_queue_size": 16384,
      "alerts_queue_usage": 0,
      "alerts_queue_size": 16384,
      "firewall_queue_usage": 0,
      "firewall_queue_size": 16384,
      "statistical_queue_usage": 0,
      "statistical_queue_size": 16384,
      "archives_queue_usage": 0,
      "archives_queue_size": 16384
   }
}

Get manager stats

Returns Wazuh statistical information for the current or specified date.

Request:

GET

/manager/stats

Parameters:

Param	Type	Description
`date`	String	Selects the date for getting the statistical information. Format: YYYYMMDD

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/manager/stats?pretty"

Example Response:

{
    "error": 0,
    "data": [
        {
            "hour": 5,
            "firewall": 0,
            "alerts": [
                {
                    "times": 4,
                    "sigid": 5715,
                    "level": 3
                },
                {
                    "times": 2,
                    "sigid": 1002,
                    "level": 2
                },
                {
                    "...": "..."
                }
            ],
            "totalAlerts": 107,
            "syscheck": 1257,
            "events": 1483
        },
        {
            "...": "..."
        }
    ]
}

Get manager stats by hour

Returns Wazuh statistical information per hour. Each number in the averages field represents the average of alerts per hour.

Request:

GET

/manager/stats/hourly

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/manager/stats/hourly?pretty"

Example Response:

{
    "error": 0,
    "data": {
        "averages": [
            100,
            357,
            242,
            500,
            422,
            "...",
            123
        ],
        "interactions": 0
    }
}

Get manager stats by week

Returns Wazuh statistical information per week. Each number in the hours field represents the average alerts per hour for that specific day.

Request:

GET

/manager/stats/weekly

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/manager/stats/weekly?pretty"

Example Response:

{
    "error": 0,
    "data": {
        "Wed": {
            "hours": [
                223,
                "...",
                456
            ],
            "interactions": 0
        },
        "Sun": {
            "hours": [
                332,
                "...",
                313
            ],
            "interactions": 0
        },
        "Fri": {
            "hours": [
                131,
                "...",
                432
            ],
            "interactions": 0
        },
        "Tue": {
            "hours": [
                536,
                "...",
                345
            ],
            "interactions": 0
        },
        "Mon": {
            "hours": [
                444,
                "...",
                556
            ],
            "interactions": 0
        },
        "Thu": {
            "hours": [
                888,
                "...",
                123
            ],
            "interactions": 0
        },
        "Sat": {
            "hours": [
                134,
                "...",
                995
            ],
            "interactions": 0
        }
    }
}

Get remoted stats

Returns a summary of the current remoted stats.

Request:

GET

/manager/stats/remoted

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/manager/stats/remoted?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "queue_size": 0,
      "total_queue_size": 131072,
      "tcp_sessions": 0,
      "evt_count": 2149,
      "ctrl_msg_count": 17,
      "discarded_count": 0,
      "msg_sent": 1579,
      "recv_bytes": 498136,
      "dequeued_after_close": 0
   }
}

Rootcheck

Clear

Clear rootcheck database

Clears the rootcheck database for all agents.

Request:

DELETE

/rootcheck

Example Request:

curl -u foo:bar -k -X DELETE "https://127.0.0.1:55000/rootcheck?pretty"

Example Response:

{
    "error": 0,
    "data": "Rootcheck database deleted"
}

Clear rootcheck database of an agent

Clears the rootcheck database for a specific agent.

Request:

DELETE

/rootcheck/:agent_id

Parameters:

Param	Type	Description
`agent_id`	Number	Agent ID.

Example Request:

curl -u foo:bar -k -X DELETE "https://127.0.0.1:55000/rootcheck/000?pretty"

Example Response:

{
    "error": 0,
    "data": "Rootcheck database deleted"
}

Info

Get last rootcheck scan

Returns the timestamp of the last rootcheck scan.

Request:

GET

/rootcheck/:agent_id/last_scan

Parameters:

Param	Type	Description
`agent_id`	Number	Agent ID.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/rootcheck/000/last_scan?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "end": "2020-03-11 14:40:41",
      "start": "2020-03-11 14:40:23"
   }
}

Get rootcheck CIS requirements

Returns the CIS requirements of all rootchecks of the specified agent.

Request:

GET

/rootcheck/:agent_id/cis

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/rootcheck/000/cis?offset=0&limit=10&pretty"

Example Response:

{
   "error": 0,
   "data": {
      "totalItems": 2,
      "items": [
         "2.3 RHEL7",
         "1.4 RHEL74"
      ]
   }
}

Get rootcheck database

Returns the rootcheck database of an agent.

Request:

GET

/rootcheck/:agent_id

Parameters:

Param	Type	Description
`agent_id`	Number	Agent ID.
`pci`	String	Filters by pci requirement.
`cis`	String	Filters by CIS.
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`status`	String	Filters by status.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/rootcheck/000?offset=0&limit=2&pretty"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "readDay": "2020-03-11 14:40:25",
            "status": "outstanding",
            "oldDay": "2020-03-11 14:40:25",
            "event": "File '/root/.npm/_cacache/index-v5/f6/fe/9c43f3b048ef1201673bfea640b64c9d4b5264f75c3fa308f333a57f6e47' is owned by root and has written permissions to anyone."
         }
      ],
      "totalItems": 1
   }
}

Get rootcheck pci requirements

Returns the PCI requirements of all rootchecks of the agent.

Request:

GET

/rootcheck/:agent_id/pci

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/rootcheck/000/pci?offset=0&limit=10&pretty"

Example Response:

{
   "error": 0,
   "data": {
      "totalItems": 2,
      "items": [
         "4.1",
         "2.2.4"
      ]
   }
}

Run

Run rootcheck scan in all agents

Runs syscheck and rootcheck on all agents (Wazuh launches both processes simultaneously).

Request:

PUT

/rootcheck

Example Request:

curl -u foo:bar -k -X PUT "https://127.0.0.1:55000/rootcheck?pretty"

Example Response:

{
    "error": 0,
    "data": "Restarting Syscheck/Rootcheck on all agents"
}

Run rootcheck scan in an agent

Runs syscheck and rootcheck on a specified agent (Wazuh launches both processes simultaneously)

Request:

PUT

/rootcheck/:agent_id

Parameters:

Param	Type	Description
`agent_id`	Number	Agent ID.

Example Request:

curl -u foo:bar -k -X PUT "https://127.0.0.1:55000/rootcheck/000?pretty"

Example Response:

{
   "error": 0,
   "data": "Restarting Syscheck/Rootcheck locally"
}

Rules

Info

Get all rules

Returns all rules.

Request:

GET

/rules

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`status`	String	Filters the rules by status. Allowed values: enabled disabled all
`group`	String	Filters the rules by group.
`level`	Range	Filters the rules by level. level=2 or level=2-5.
`path`	String	Filters the rules by path.
`file`	String	Filters the rules by file name.
`pci`	String	Filters the rules by pci requirement.
`gdpr`	String	Filters the rules by gdpr requirement.
`hipaa`	String	Filters the rules by hipaa requirement.
`nist-800-53`	String	Filters the rules by nist-800-53 requirement.
`gpg13`	String	Filters the rules by gpg13 requirement.
`q`	String	Query to filter results by. For example q=id=89055

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/rules?offset=0&limit=2&pretty"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "file": "0010-rules_config.xml",
            "path": "ruleset/rules",
            "id": 1,
            "description": "Generic template for all syslog rules.",
            "level": 0,
            "status": "enabled",
            "groups": [
               "syslog"
            ],
            "pci": [],
            "gdpr": [],
            "hipaa": [],
            "nist-800-53": [],
            "gpg13": [],
            "details": {
               "noalert": "1",
               "category": "syslog"
            }
         },
         {
            "file": "0010-rules_config.xml",
            "path": "ruleset/rules",
            "id": 2,
            "description": "Generic template for all firewall rules.",
            "level": 0,
            "status": "enabled",
            "groups": [
               "firewall"
            ],
            "pci": [],
            "gdpr": [],
            "hipaa": [],
            "nist-800-53": [],
            "gpg13": [],
            "details": {
               "noalert": "1",
               "category": "firewall"
            }
         }
      ],
      "totalItems": 2869
   }
}

Get files of rules

Returns the files of all rules.

Request:

GET

/rules/files

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`status`	String	Filters files by status. Allowed values: enabled disabled all
`path`	String	Filters the rules by path.
`file`	String	Filters the rules by filefile.
`download`	String	Downloads the file

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/rules/files?offset=0&limit=10&pretty"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "file": "0010-rules_config.xml",
            "path": "ruleset/rules",
            "status": "enabled"
         },
         {
            "file": "0015-ossec_rules.xml",
            "path": "ruleset/rules",
            "status": "enabled"
         },
         {
            "file": "0016-wazuh_rules.xml",
            "path": "ruleset/rules",
            "status": "enabled"
         },
         {
            "file": "0020-syslog_rules.xml",
            "path": "ruleset/rules",
            "status": "enabled"
         },
         {
            "file": "0025-sendmail_rules.xml",
            "path": "ruleset/rules",
            "status": "enabled"
         },
         {
            "file": "0030-postfix_rules.xml",
            "path": "ruleset/rules",
            "status": "enabled"
         },
         {
            "file": "0035-spamd_rules.xml",
            "path": "ruleset/rules",
            "status": "enabled"
         },
         {
            "file": "0040-imapd_rules.xml",
            "path": "ruleset/rules",
            "status": "enabled"
         },
         {
            "file": "0045-mailscanner_rules.xml",
            "path": "ruleset/rules",
            "status": "enabled"
         },
         {
            "file": "0050-ms-exchange_rules.xml",
            "path": "ruleset/rules",
            "status": "enabled"
         }
      ],
      "totalItems": 127
   }
}

Get rule gdpr requirements

Returns the GDPR requirements of all rules.

Request:

GET

/rules/gdpr

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/rules/gdpr?offset=0&limit=10&pretty"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         "II_5.1.f",
         "IV_30.1.g",
         "IV_32.2",
         "IV_35.7.d"
      ],
      "totalItems": 4
   }
}

Get rule gpg13 requirements

Returns the GPG13 requirements of all rules.

Request:

GET

/rules/gpg13

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/rules/gpg13?offset=0&limit=10&pretty"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         "1.3",
         "10.1",
         "3.1",
         "3.2",
         "3.3",
         "3.5",
         "3.6",
         "3.7",
         "4.1",
         "4.10"
      ],
      "totalItems": 28
   }
}

Get rule groups

Returns the groups of all rules.

Request:

GET

/rules/groups

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/rules/groups?offset=0&limit=10&pretty"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         "access_control",
         "access_denied",
         "accesslog",
         "account_changed",
         "active_response",
         "adduser",
         "agent",
         "agent_flooding",
         "agent_restarting",
         "agentless"
      ],
      "totalItems": 300
   }
}

Get rule hipaa requirements

Returns the HIPAA requirements of all rules.

Request:

GET

/rules/hipaa

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/rules/hipaa?offset=0&limit=10&pretty"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         "164.312.a.1",
         "164.312.a.2.I",
         "164.312.a.2.II",
         "164.312.a.2.III",
         "164.312.a.2.IV",
         "164.312.b",
         "164.312.c.1",
         "164.312.c.2",
         "164.312.d",
         "164.312.e.1"
      ],
      "totalItems": 12
   }
}

Get rule nist-800-53 requirements

Returns the NIST-800-53 requirements of all rules.

Request:

GET

/rules/nist-800-53

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/rules/nist-800-53?offset=0&limit=10&pretty"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         "AC.12",
         "AC.2",
         "AC.6",
         "AC.7",
         "AU.12",
         "AU.14",
         "AU.5",
         "AU.6",
         "AU.8",
         "AU.9"
      ],
      "totalItems": 25
   }
}

Get rule pci requirements

Returns the PCI requirements of all rules.

Request:

GET

/rules/pci

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/rules/pci?offset=0&limit=10&pretty"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         "1.1.1",
         "1.3.4",
         "1.4",
         "10.1",
         "10.2.1",
         "10.2.2",
         "10.2.4",
         "10.2.5",
         "10.2.6",
         "10.2.7"
      ],
      "totalItems": 40
   }
}

Get rules by id

Returns the rules with the specified id.

Request:

GET

/rules/:rule_id

Parameters:

Param	Type	Description
`id`	Number	rule.
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/rules/1002?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "file": "0020-syslog_rules.xml",
            "path": "ruleset/rules",
            "id": 1002,
            "description": "Unknown problem somewhere in the system.",
            "level": 2,
            "status": "enabled",
            "groups": [
               "syslog",
               "errors"
            ],
            "pci": [],
            "gdpr": [],
            "hipaa": [],
            "nist-800-53": [],
            "gpg13": [
               "4.3"
            ],
            "details": {
               "match": "core_dumped|failure|error|attack| bad |illegal |denied|refused|unauthorized|fatal|failed|Segmentation Fault|Corrupted"
            }
         }
      ],
      "totalItems": 1
   }
}

Security Configuration Assessment

Info

Get security configuration assessment (SCA) checks database

Returns the sca checks of an agent.

Request:

GET

/sca/:agent_id/checks/:policy_id

Parameters:

Param	Type	Description
`agent_id`	Number	Agent ID.
`policy_id`	String	Filters by policy id
`title`	String	Filters by title
`description`	String	Filters by policy description
`rationale`	String	Filters by rationale
`remediation`	String	Filters by remediation
`file`	String	Filters by file
`process`	String	Filters by process
`directory`	String	Filters by directory
`registry`	String	Filters by registry
`references`	String	Filters by references
`result`	String	Filters by result
`condition`	String	Filters by condition
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/sca/000/checks/unix_audit?limit=1&pretty"

Example Response:

{
   "error": 0,
   "data": {
      "totalItems": 23,
      "items": [
         {
            "id": 4022,
            "rationale": "The capturing of system events provides system administrators with information to allow them to determine if unauthorized access to their system is occurring.",
            "title": "Ensure auditd service is enabled",
            "remediation": "Run the following command to enable auditd: # systemctl enable auditd",
            "result": "failed",
            "policy_id": "unix_audit",
            "reason": "",
            "description": "Turn on the auditd daemon to record system events.",
            "condition": "all",
            "status": "",
            "command": "systemctl is-enabled auditd",
            "compliance": [
               {
                  "key": "cis_csc",
                  "value": "6.2,6.3"
               }
            ],
            "rules": [
               {
                  "type": "command",
                  "rule": "c:systemctl is-enabled auditd -> r:^enabled"
               }
            ]
         }
      ]
   }
}

Get security configuration assessment (SCA) database

Returns the sca database of an agent.

Request:

GET

/sca/:agent_id

Parameters:

Param	Type	Description
`agent_id`	Number	Agent ID.
`name`	String	Filters by policy name.
`description`	String	Filters by policy description
`references`	String	Filters by references
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`q`	String	Query to filter results by. This is specially useful to filter by total checks passed, failed or total score (fields pass, fail, score).

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/sca/000?q=pass>2;score<150&pretty&limit=2"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "score": 25,
            "policy_id": "unix_audit",
            "pass": 4,
            "invalid": 7,
            "references": "https://www.ssh.com/ssh/",
            "hash_file": "c07d31fa918a0e2b430abaaae0b9fc3b5abd469fd057e2c0a205a4ece4b9c41f",
            "total_checks": 23,
            "end_scan": "2020-03-11 14:40:07",
            "start_scan": "2020-03-11 14:40:07",
            "name": "System audit for Unix based systems",
            "fail": 12,
            "description": "Guidance for establishing a secure configuration for Unix based systems."
         }
      ],
      "totalItems": 1
   }
}

Summary

Info

Get a full summary of agents

Returns a dictionary with a full summary of agents.

Request:

GET

/summary/agents

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/summary/agents?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "nodes": {
         "items": [
            {
               "node_name": "master",
               "count": 2
            },
            {
               "node_name": "worker-1",
               "count": 1
            },
            {
               "node_name": "worker-2",
               "count": 1
            },
            {
               "node_name": "unknown",
               "count": 7
            }
         ],
         "totalItems": 11
      },
      "groups": {
         "items": [
            {
               "count": 5,
               "name": "default",
               "mergedSum": "438c69bbca3caceabac91d821004c6ab",
               "configSum": "ab73af41699f13fdd81903b5f23d8d00"
            },
            {
               "count": 0,
               "name": "pciserver",
               "mergedSum": "bea4f89b64fd7928060d027725e580c6",
               "configSum": "ab73af41699f13fdd81903b5f23d8d00"
            }
         ],
         "totalItems": 2
      },
      "agent_os": {
         "items": [
            {
               "os": {
                  "name": "CentOS Linux",
                  "platform": "centos",
                  "version": "8.1"
               },
               "count": 3
            },
            {
               "os": {
                  "name": "CentOS Linux",
                  "platform": "centos",
                  "version": "8"
               },
               "count": 1
            },
            {
               "count": 7
            }
         ],
         "totalItems": 11
      },
      "agent_status": {
         "Total": 11,
         "Active": 4,
         "Disconnected": 0,
         "Never connected": 7,
         "Pending": 0
      },
      "agent_version": {
         "items": [
            {
               "count": 1,
               "version": "Wazuh v3.12.3"
            },
            {
               "count": 2,
               "version": "Wazuh v3.12.3"
            },
            {
               "count": 1,
               "version": "Wazuh v3.5.0"
            },
            {
               "count": 7
            }
         ],
         "totalItems": 11
      },
      "last_registered_agent": {
         "status": "Never connected",
         "dateAdd": "2020-03-11 14:41:58",
         "ip": "10.0.0.9",
         "registerIP": "10.0.0.9",
         "name": "NewHost",
         "id": "009",
         "node_name": "unknown"
      }
   }
}

Syscheck

Clear

Clear syscheck database of an agent

Clears the syscheck database for the specified agent.

Request:

DELETE

/syscheck/:agent_id

Parameters:

Param	Type	Description
`agent_id`	Number	Agent ID.

Example Request:

curl -u foo:bar -k -X DELETE "https://127.0.0.1:55000/syscheck/000?pretty"

Example Response:

{
    "error": 0,
    "data": "Syscheck database deleted"
}

Info

Get last syscheck scan

Return the timestamp of the last syscheck scan.

Request:

GET

/syscheck/:agent_id/last_scan

Parameters:

Param	Type	Description
`agent_id`	Number	Agent ID.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/syscheck/000/last_scan?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "start": "2020-03-11 14:42:22",
      "end": "2020-03-11 14:40:43"
   }
}

Get syscheck files

Returns the syscheck files of an agent.

Request:

GET

/syscheck/:agent_id

Parameters:

Param	Type	Description
`agent_id`	Number	Agent ID.
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`file`	String	Filters file by filename.
`type`	String	Selects type of file. Allowed values: file registry
`summary`	String	Returns a summary grouping by filename. Allowed values: yes no
`select`	String	List of selected fields separated by commas.
`distinct`	Empty_Boolean	Whether to return only distinct values or not.
`md5`	String	Returns the files with the specified md5 hash.
`sha1`	String	Returns the files with the specified sha1 hash.
`sha256`	String	Returns the files with the specified sha256 hash.
`hash`	String	Returns the files with the specified hash (md5, sha1 or sha256).
`q`	string	Advanced query filtering

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/syscheck/000?offset=0&limit=2&pretty"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "inode": 16921835,
            "sha256": "c1259ead36165a9477c9e1948500fb1ae58f33140d2c8b9fdf09ae54425d62b6",
            "uid": "0",
            "size": 642,
            "date": "2020-03-11 14:40:28",
            "mtime": "2016-12-09 19:11:13",
            "md5": "d1e7e7add29e247fdcf2a098fe5b37a0",
            "gname": "root",
            "perm": "100644",
            "sha1": "54113a3771fd7b2b8bb63ccf0a899ac9af88f685",
            "uname": "root",
            "file": "/etc/xattr.conf",
            "type": "file",
            "gid": "0"
         },
         {
            "inode": 17060873,
            "sha256": "77976ab8c2b73c5951600cb43526076c28a650677988df1c9a8e981ea9d65c9f",
            "uid": "0",
            "size": 2151,
            "date": "2020-03-11 14:40:28",
            "mtime": "2017-02-10 13:50:08",
            "md5": "1f814b47cc24ab813961e2939d1db23c",
            "gname": "root",
            "perm": "100644",
            "sha1": "8e1dde40834f87a44cd6cbe209c3bbcc45ab9ac0",
            "uname": "root",
            "file": "/etc/security/pwquality.conf",
            "type": "file",
            "gid": "0"
         }
      ],
      "totalItems": 957
   }
}

Run

Run syscheck scan in all agents

Runs syscheck and rootcheck on all agents (Wazuh launches both processes simultaneously).

Request:

PUT

/syscheck

Example Request:

curl -u foo:bar -k -X PUT "https://127.0.0.1:55000/syscheck?pretty"

Example Response:

{
    "error": 0,
    "data": "Restarting Syscheck/Rootcheck on all agents"
}

Run syscheck scan in an agent

Runs syscheck and rootcheck on an agent (Wazuh launches both processes simultaneously).

Request:

PUT

/syscheck/:agent_id

Parameters:

Param	Type	Description
`agent_id`	Number	Agent ID.

Example Request:

curl -u foo:bar -k -X PUT "https://127.0.0.1:55000/syscheck/000?pretty"

Example Response:

{
   "error": 0,
   "data": "Restarting Syscheck/Rootcheck locally"
}

Syscollector

Hardware

Get hardware info

Returns the agent's hardware info.

Request:

GET

/syscollector/:agent_id/hardware

Parameters:

Param	Type	Description
`agent_id`	Number	Agent ID.
`select`	String	List of selected fields separated by commas.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/syscollector/000/hardware?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "cpu": {
         "cores": 8,
         "mhz": 3460.966,
         "name": "Intel(R) Core(TM) i5-9300H CPU @ 2.40GHz"
      },
      "ram": {
         "free": 598588,
         "total": 16024656,
         "usage": 97
      },
      "scan": {
         "id": 1787159141,
         "time": "2020/03/11 14:40:08"
      },
      "board_serial": "/72NL9Y2/CNCMK009B30174/"
   }
}

Hotfixes

Get hotfixes info

Returns all hotfixes installed by Microsoft(R) in Windows(R) systems (KB... fixes)

Request:

GET

/syscollector/:agent_id/hotfixes

Parameters:

Param	Type	Description
`agent_id`	Number	Agent ID.
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`select`	String	List of selected fields.
`q`	String	Query to filter results by.
`hotfix`	String	Filters by hotfix.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/syscollector/001/hotfixes?pretty&limit=2"

Example Response:

{
   "error": 0,
   "data": {
      "items": [],
      "totalItems": 0
   }
}

Netaddr

Get network address info of an agent

Returns the agent's network address info.

Request:

GET

/syscollector/:agent_id/netaddr

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`select`	String	List of selected fields separated by commas.
`q`	String	Query to filter results by.
`iface`	String	Filters by interface name.
`proto`	String	Filters by proto.
`address`	String	Filters by address.
`broadcast`	String	Filters by broadcast.
`netmask`	String	Filters by netmask.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/syscollector/000/netaddr?pretty&limit=2&sort=proto"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "scan": {
               "id": 370984796
            },
            "address": "172.23.0.2",
            "netmask": "255.255.0.0",
            "iface": "eth0",
            "proto": "ipv4",
            "broadcast": "172.23.255.255"
         }
      ],
      "totalItems": 1
   }
}

Netiface

Get network interface info of an agent

Returns the agent's network interface info.

Request:

GET

/syscollector/:agent_id/netiface

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`select`	String	List of selected fields separated by commas.
`q`	String	Query to filter results by.
`name`	String	Filters by name.
`adapter`	String	Filters by adapter.
`type`	String	Filters by type.
`state`	String	Filters by state.
`mtu`	String	Filters by mtu.
`tx_packets`	String	Filters by tx_packets.
`rx_packets`	String	Filters by rx_packets.
`tx_bytes`	String	Filters by tx_bytes.
`rx_bytes`	String	Filters by rx_bytes.
`tx_errors`	String	Filters by tx_errors.
`rx_errors`	String	Filters by rx_errors.
`tx_dropped`	String	Filters by tx_dropped.
`rx_dropped`	String	Filters by rx_dropped.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/syscollector/000/netiface?pretty&limit=2&sort=state"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "rx": {
               "bytes": 8164,
               "dropped": 0,
               "errors": 0,
               "packets": 59
            },
            "scan": {
               "id": 370984796,
               "time": "2020/03/11 14:40:07"
            },
            "tx": {
               "bytes": 504,
               "dropped": 0,
               "errors": 0,
               "packets": 6
            },
            "type": "ethernet",
            "name": "eth0",
            "state": "up",
            "mtu": 1500,
            "mac": "02:42:ac:17:00:02"
         }
      ],
      "totalItems": 1
   }
}

Netproto

Get network protocol info of an agent

Returns the agent's network protocol info.

Request:

GET

/syscollector/:agent_id/netproto

Parameters:

Param	Type	Description
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`select`	String	List of selected fields separated by commas.
`q`	String	Query to filter results by.
`iface`	String	Filters by iface.
`type`	String	Filters by type.
`gateway`	String	Filters by gateway.
`dhcp`	String	Filters by dhcp.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/syscollector/000/netproto?pretty&limit=2&sort=type"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "scan": {
               "id": 370984796
            },
            "type": "ipv4",
            "iface": "eth0",
            "dhcp": "enabled",
            "gateway": "172.23.0.1"
         }
      ],
      "totalItems": 1
   }
}

OS

Get os info

Returns the agent's OS info.

Request:

GET

/syscollector/:agent_id/os

Parameters:

Param	Type	Description
`agent_id`	Number	Agent ID.
`select`	String	List of selected fields separated by commas.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/syscollector/000/os?pretty"

Example Response:

{
   "error": 0,
   "data": {
      "os": {
         "major": "8",
         "minor": "1",
         "name": "CentOS Linux",
         "platform": "centos",
         "version": "8.1"
      },
      "scan": {
         "id": 1128899975,
         "time": "2020/03/11 14:40:08"
      },
      "version": "#32-Ubuntu SMP Fri Jan 31 20:24:34 UTC 2020",
      "architecture": "x86_64",
      "release": "5.3.0-40-generic",
      "hostname": "f2fe0a2b2d94",
      "sysname": "Linux"
   }
}

Packages

Get packages info

Returns the agent's packages info.

Request:

GET

/syscollector/:agent_id/packages

Parameters:

Param	Type	Description
`agent_id`	Number	Agent ID.
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`select`	String	List of selected fields separated by commas.
`q`	String	Query to filter results by.
`vendor`	String	Filters by vendor.
`name`	String	Filters by name.
`architecture`	String	Filters by architecture.
`format`	String	Filters by format.
`version`	String	Filters by version.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/syscollector/000/packages?pretty&limit=2&offset=10&sort=-name"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "scan": {
               "id": 1446174342,
               "time": "2020/03/11 14:40:08"
            },
            "name": "tar",
            "size": 2846,
            "vendor": "CentOS",
            "install_time": "2020/01/13 21:49:20",
            "version": "2:1.30-4.el8",
            "section": "Applications/Archiving",
            "description": "A GNU file archiving program",
            "format": "rpm",
            "architecture": "x86_64"
         },
         {
            "scan": {
               "id": 1446174342,
               "time": "2020/03/11 14:40:08"
            },
            "name": "systemd-udev",
            "size": 8116,
            "vendor": "CentOS",
            "install_time": "2020/01/13 21:49:18",
            "version": "239-18.el8_1.1",
            "section": "Unspecified",
            "description": "Rule-based device node and kernel event manager",
            "format": "rpm",
            "architecture": "x86_64"
         }
      ],
      "totalItems": 261
   }
}

Ports

Get ports info of an agent

Returns the agent's ports info.

Request:

GET

/syscollector/:agent_id/ports

Parameters:

Param	Type	Description
`agent_id`	Number	Agent ID.
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`select`	String	List of selected fields separated by commas.
`q`	String	Query to filter results by.
`pid`	Number	Filters by pid.
`protocol`	String	Filters by protocol.
`local_ip`	String	Filters by local_ip.
`local_port`	Number	Filters by local_port.
`remote_ip`	String	Filters by remote_ip.
`tx_queue`	Number	Filters by tx_queue.
`state`	String	Filters by state.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/syscollector/000/ports?pretty&sort=-protocol&limit=2"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "local": {
               "ip": "::",
               "port": 22
            },
            "remote": {
               "ip": "::",
               "port": 0
            },
            "scan": {
               "id": 10385605,
               "time": "2020/03/11 14:40:11"
            },
            "state": "listening",
            "protocol": "tcp6",
            "tx_queue": 0,
            "rx_queue": 0,
            "inode": 13042011
         },
         {
            "local": {
               "ip": "::",
               "port": 55000
            },
            "remote": {
               "ip": "::",
               "port": 0
            },
            "scan": {
               "id": 10385605,
               "time": "2020/03/11 14:40:11"
            },
            "state": "listening",
            "protocol": "tcp6",
            "tx_queue": 0,
            "rx_queue": 0,
            "inode": 13045023
         }
      ],
      "totalItems": 6
   }
}

Processes

Get processes info

Returns the agent's processes info.

Request:

GET

/syscollector/:agent_id/processes

Parameters:

Param	Type	Description
`agent_id`	Number	Agent ID.
`offset`	Number	First element to return in the collection.
`limit`	Number	Maximum number of elements to return.
`sort`	String	Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.
`search`	String	Looks for elements with the specified string.
`select`	String	List of selected fields separated by commas.
`q`	String	Query to filter results by.
`pid`	Number	Filters by process pid.
`state`	String	Filters by process state.
`ppid`	Number	Filters by process parent pid.
`egroup`	String	Filters by process egroup.
`euser`	String	Filters by process euser.
`fgroup`	String	Filters by process fgroup.
`name`	String	Filters by process name.
`nlwp`	Number	Filters by process nlwp.
`pgrp`	Number	Filters by process pgrp.
`priority`	Number	Filters by process priority.
`rgroup`	String	Filters by process rgroup.
`ruser`	String	Filters by process ruser.
`sgroup`	String	Filters by process sgroup.
`suser`	String	Filters by process suser.

Example Request:

curl -u foo:bar -k -X GET "https://127.0.0.1:55000/syscollector/000/processes?pretty&limit=2&offset=10&sort=-name"

Example Response:

{
   "error": 0,
   "data": {
      "items": [
         {
            "scan": {
               "id": 1430619430,
               "time": "2020/03/11 14:40:11"
            },
            "nice": 0,
            "nlwp": 2,
            "vm_size": 30772,
            "session": 103,
            "sgroup": "ossec",
            "fgroup": "ossec",
            "start_time": 2748219,
            "priority": 20,
            "state": "S",
            "size": 7693,
            "ppid": 1,
            "cmd": "/var/ossec/bin/ossec-integratord",
            "resident": 757,
            "ruser": "ossecm",
            "suser": "ossecm",
            "pid": "104",
            "egroup": "ossec",
            "pgrp": 103,
            "tty": 0,
            "euser": "ossecm",
            "utime": 0,
            "name": "ossec-integrato",
            "rgroup": "ossec",
            "tgid": 104,
            "share": 517,
            "stime": 0,
            "processor": 2
         },
         {
            "scan": {
               "id": 1430619430,
               "time": "2020/03/11 14:40:11"
            },
            "nice": 0,
            "nlwp": 2,
            "vm_size": 30828,
            "session": 186,
            "sgroup": "ossec",
            "fgroup": "ossec",
            "start_time": 2748335,
            "priority": 20,
            "state": "S",
            "size": 7707,
            "ppid": 1,
            "cmd": "/var/ossec/bin/ossec-execd",
            "resident": 757,
            "ruser": "root",
            "suser": "root",
            "pid": "187",
            "egroup": "ossec",
            "pgrp": 186,
            "tty": 0,
            "euser": "root",
            "utime": 0,
            "name": "ossec-execd",
            "rgroup": "ossec",
            "tgid": 187,
            "share": 492,
            "stime": 0,
            "processor": 6
         }
      ],
      "totalItems": 18
   }
}