# wazuh/wazuh-api architecture

> Architecture diagram of the GitHub repository wazuh/wazuh-api, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/wazuh/wazuh-api
- Repository: https://github.com/wazuh/wazuh-api

## Overview

Wazuh API is a REST interface for remotely managing and querying Wazuh. Clients send HTTP requests through the configured server and API router to domain controllers; supported controller workflows validate requests, invoke the Wazuh Python command interface, and format responses. The README documents additional management, assessment, ruleset, and statistics capabilities represented by their controller modules. The sampled excerpts show routing and selected controller-to-helper calls; relationships among unsampled controller internals are not inferred.

Main entry points: [`controllers/index.js`](https://github.com/wazuh/wazuh-api/blob/master/controllers/index.js) (API router), [`helpers/execute.js`](https://github.com/wazuh/wazuh-api/blob/master/helpers/execute.js) (Command execution), [`helpers/response_handler.js`](https://github.com/wazuh/wazuh-api/blob/master/helpers/response_handler.js) (Response handling), [`controllers/agents.js`](https://github.com/wazuh/wazuh-api/blob/master/controllers/agents.js) (Agent management)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_runtime["API runtime"]
  node_server["HTTP server<br/>[app.js]"]
  node_settings["API settings<br/>[config.js]"]
  node_router["API router<br/>[index.js]"]
end

subgraph group_management["Management"]
  node_agents["Agent management<br/>[agents.js]"]
  node_manager["Manager overview<br/>[manager.js]"]
  node_cluster["Cluster control<br/>[cluster.js]"]
  node_active["Active response<br/>[active_response.js]"]
end

subgraph group_security["Security operations"]
  node_syscheck["Syscheck search<br/>[syscheck.js]"]
  node_rootcheck["Rootcheck search<br/>[rootcheck.js]"]
  node_sca["Security assessment"]
  node_rules["Ruleset information<br/>[rules.js]"]
  node_decoders["Decoder information<br/>[decoders.js]"]
  node_ciscat["CIS-CAT results<br/>[ciscat.js]"]
end

subgraph group_insight["Inventory and insight"]
  node_syscollector["System inventory<br/>[syscollector.js]"]
  node_summary["Statistics summary<br/>[summary.js]"]
  node_mitre["MITRE information<br/>[mitre.js]"]
  node_lists["CDB lists<br/>[lists.js]"]
  node_cache["Cache control<br/>[cache.js]"]
  node_experimental["Experimental APIs<br/>[experimental.js]"]
end

subgraph group_shared["Shared services"]
  node_filters["Request validation<br/>[filters.js]"]
  node_templates["Request templates"]
  node_execute["Command execution<br/>[execute.js]"]
  node_bridge["Wazuh command bridge<br/>[wazuh-api.py]"]
  node_response["Response handling"]
  node_errors["Error catalog<br/>[errors.js]"]
  node_logger["API logging<br/>[logger.js]"]
end

node_client(("API client"))

node_client -->|"sends requests"| node_server
node_server -->|"loads settings"| node_settings
node_server -->|"mounts routes"| node_router
node_router -->|"routes requests"| node_agents
node_router -->|"routes requests"| node_manager
node_router -->|"routes requests"| node_cluster
node_router -->|"routes requests"| node_active
node_router -->|"routes requests"| node_syscheck
node_router -->|"routes requests"| node_rootcheck
node_router -->|"routes requests"| node_sca
node_router -->|"routes requests"| node_rules
node_router -->|"routes requests"| node_decoders
node_router -->|"routes requests"| node_ciscat
node_router -->|"routes requests"| node_syscollector
node_router -->|"routes requests"| node_summary
node_router -->|"routes requests"| node_mitre
node_router -->|"routes requests"| node_lists
node_router -->|"routes requests"| node_cache
node_router -.->|"conditionally routes"| node_experimental
node_router -->|"uses validation"| node_filters
node_router -->|"sets execution options"| node_execute
node_router -->|"uses templates"| node_templates
node_agents -->|"validates inputs"| node_filters
node_agents -->|"builds requests"| node_templates
node_agents -->|"invokes commands"| node_execute
node_manager -->|"validates inputs"| node_filters
node_manager -->|"invokes commands"| node_execute
node_execute -->|"runs command"| node_bridge
node_manager -->|"formats result"| node_response
node_agents -->|"formats result"| node_response
node_server -->|"uses response handling"| node_response
node_response -->|"looks up errors"| node_errors
node_response -->|"logs responses"| node_logger
node_response -->|"reads API settings"| node_settings
node_execute -->|"maps failures"| node_errors
node_execute -->|"logs execution"| node_logger

click node_server "https://github.com/wazuh/wazuh-api/blob/master/app.js"
click node_settings "https://github.com/wazuh/wazuh-api/blob/master/configuration/config.js"
click node_router "https://github.com/wazuh/wazuh-api/blob/master/controllers/index.js"
click node_agents "https://github.com/wazuh/wazuh-api/blob/master/controllers/agents.js"
click node_manager "https://github.com/wazuh/wazuh-api/blob/master/controllers/manager.js"
click node_cluster "https://github.com/wazuh/wazuh-api/blob/master/controllers/cluster.js"
click node_active "https://github.com/wazuh/wazuh-api/blob/master/controllers/active_response.js"
click node_syscheck "https://github.com/wazuh/wazuh-api/blob/master/controllers/syscheck.js"
click node_rootcheck "https://github.com/wazuh/wazuh-api/blob/master/controllers/rootcheck.js"
click node_sca "https://github.com/wazuh/wazuh-api/blob/master/controllers/security_configuration_assessment.js"
click node_rules "https://github.com/wazuh/wazuh-api/blob/master/controllers/rules.js"
click node_decoders "https://github.com/wazuh/wazuh-api/blob/master/controllers/decoders.js"
click node_ciscat "https://github.com/wazuh/wazuh-api/blob/master/controllers/ciscat.js"
click node_syscollector "https://github.com/wazuh/wazuh-api/blob/master/controllers/syscollector.js"
click node_summary "https://github.com/wazuh/wazuh-api/blob/master/controllers/summary.js"
click node_mitre "https://github.com/wazuh/wazuh-api/blob/master/controllers/mitre.js"
click node_lists "https://github.com/wazuh/wazuh-api/blob/master/controllers/lists.js"
click node_cache "https://github.com/wazuh/wazuh-api/blob/master/controllers/cache.js"
click node_experimental "https://github.com/wazuh/wazuh-api/blob/master/controllers/experimental.js"
click node_filters "https://github.com/wazuh/wazuh-api/blob/master/helpers/filters.js"
click node_templates "https://github.com/wazuh/wazuh-api/blob/master/helpers/request_templates.js"
click node_execute "https://github.com/wazuh/wazuh-api/blob/master/helpers/execute.js"
click node_bridge "https://github.com/wazuh/wazuh-api/blob/master/models/wazuh-api.py"
click node_response "https://github.com/wazuh/wazuh-api/blob/master/helpers/response_handler.js"
click node_errors "https://github.com/wazuh/wazuh-api/blob/master/helpers/errors.js"
click node_logger "https://github.com/wazuh/wazuh-api/blob/master/helpers/logger.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_server,node_settings,node_router,node_client toneBlue
class node_agents,node_manager,node_cluster,node_active toneAmber
class node_syscheck,node_rootcheck,node_sca,node_rules,node_decoders,node_ciscat toneMint
class node_syscollector,node_summary,node_mitre,node_lists,node_cache,node_experimental toneRose
class node_filters,node_templates,node_execute,node_bridge,node_response,node_errors,node_logger toneIndigo
```

## Components

### API runtime

- [HTTP server](https://github.com/wazuh/wazuh-api/blob/master/app.js): `app.js`
- [API settings](https://github.com/wazuh/wazuh-api/blob/master/configuration/config.js): `configuration/config.js`
- [API router](https://github.com/wazuh/wazuh-api/blob/master/controllers/index.js): `controllers/index.js`

### Management

- [Agent management](https://github.com/wazuh/wazuh-api/blob/master/controllers/agents.js): `controllers/agents.js`
- [Manager overview](https://github.com/wazuh/wazuh-api/blob/master/controllers/manager.js): `controllers/manager.js`
- [Cluster control](https://github.com/wazuh/wazuh-api/blob/master/controllers/cluster.js): `controllers/cluster.js`
- [Active response](https://github.com/wazuh/wazuh-api/blob/master/controllers/active_response.js): `controllers/active_response.js`

### Security operations

- [Syscheck search](https://github.com/wazuh/wazuh-api/blob/master/controllers/syscheck.js): `controllers/syscheck.js`
- [Rootcheck search](https://github.com/wazuh/wazuh-api/blob/master/controllers/rootcheck.js): `controllers/rootcheck.js`
- [Security assessment](https://github.com/wazuh/wazuh-api/blob/master/controllers/security_configuration_assessment.js): `controllers/security_configuration_assessment.js`
- [Ruleset information](https://github.com/wazuh/wazuh-api/blob/master/controllers/rules.js): `controllers/rules.js`
- [Decoder information](https://github.com/wazuh/wazuh-api/blob/master/controllers/decoders.js): `controllers/decoders.js`
- [CIS-CAT results](https://github.com/wazuh/wazuh-api/blob/master/controllers/ciscat.js): `controllers/ciscat.js`

### Inventory and insight

- [System inventory](https://github.com/wazuh/wazuh-api/blob/master/controllers/syscollector.js): `controllers/syscollector.js`
- [Statistics summary](https://github.com/wazuh/wazuh-api/blob/master/controllers/summary.js): `controllers/summary.js`
- [MITRE information](https://github.com/wazuh/wazuh-api/blob/master/controllers/mitre.js): `controllers/mitre.js`
- [CDB lists](https://github.com/wazuh/wazuh-api/blob/master/controllers/lists.js): `controllers/lists.js`
- [Cache control](https://github.com/wazuh/wazuh-api/blob/master/controllers/cache.js): `controllers/cache.js`
- [Experimental APIs](https://github.com/wazuh/wazuh-api/blob/master/controllers/experimental.js): `controllers/experimental.js`

### Shared services

- [Request validation](https://github.com/wazuh/wazuh-api/blob/master/helpers/filters.js): `helpers/filters.js`
- [Request templates](https://github.com/wazuh/wazuh-api/blob/master/helpers/request_templates.js): `helpers/request_templates.js`
- [Command execution](https://github.com/wazuh/wazuh-api/blob/master/helpers/execute.js): `helpers/execute.js`
- [Wazuh command bridge](https://github.com/wazuh/wazuh-api/blob/master/models/wazuh-api.py): `models/wazuh-api.py`
- [Response handling](https://github.com/wazuh/wazuh-api/blob/master/helpers/response_handler.js): `helpers/response_handler.js`
- [Error catalog](https://github.com/wazuh/wazuh-api/blob/master/helpers/errors.js): `helpers/errors.js`
- [API logging](https://github.com/wazuh/wazuh-api/blob/master/helpers/logger.js): `helpers/logger.js`

### Other components

- **API client**

## Connections

- API client → HTTP server: sends requests (evidence: `README.md`)
- HTTP server → API settings: loads settings (evidence: `app.js`)
- HTTP server → API router: mounts routes (evidence: `app.js`)
- API router → Agent management: routes requests (evidence: `controllers/index.js`)
- API router → Manager overview: routes requests (evidence: `controllers/index.js`)
- API router → Cluster control: routes requests (evidence: `controllers/index.js`)
- API router → Active response: routes requests (evidence: `controllers/index.js`)
- API router → Syscheck search: routes requests (evidence: `controllers/index.js`)
- API router → Rootcheck search: routes requests (evidence: `controllers/index.js`)
- API router → Security assessment: routes requests (evidence: `controllers/index.js`)
- API router → Ruleset information: routes requests (evidence: `controllers/index.js`)
- API router → Decoder information: routes requests (evidence: `controllers/index.js`)
- API router → CIS-CAT results: routes requests (evidence: `controllers/index.js`)
- API router → System inventory: routes requests (evidence: `controllers/index.js`)
- API router → Statistics summary: routes requests (evidence: `controllers/index.js`)
- API router → MITRE information: routes requests (evidence: `controllers/index.js`)
- API router → CDB lists: routes requests (evidence: `controllers/index.js`)
- API router → Cache control: routes requests (evidence: `controllers/index.js`)
- API router → Experimental APIs: conditionally routes (evidence: `controllers/index.js`)
- API router → Request validation: uses validation (evidence: `controllers/index.js`)
- API router → Command execution: sets execution options (evidence: `controllers/index.js`)
- API router → Request templates: uses templates (evidence: `controllers/index.js`)
- Agent management → Request validation: validates inputs (evidence: `controllers/agents.js`)
- Agent management → Request templates: builds requests (evidence: `controllers/agents.js`)
- Agent management → Command execution: invokes commands (evidence: `controllers/agents.js`)
- Manager overview → Request validation: validates inputs (evidence: `controllers/manager.js`)
- Manager overview → Command execution: invokes commands (evidence: `controllers/manager.js`)
- Command execution → Wazuh command bridge: runs command
- Manager overview → Response handling: formats result (evidence: `controllers/manager.js`)
- Agent management → Response handling: formats result (evidence: `controllers/agents.js`)
- HTTP server → Response handling: uses response handling (evidence: `app.js`)
- Response handling → Error catalog: looks up errors (evidence: `helpers/response_handler.js`)
- Response handling → API logging: logs responses (evidence: `helpers/response_handler.js`)
- Response handling → API settings: reads API settings (evidence: `helpers/response_handler.js`)
- Command execution → Error catalog: maps failures (evidence: `helpers/execute.js`)
- Command execution → API logging: logs execution (evidence: `helpers/execute.js`)
