WAZUH_COMPATIBILITY.mdโข9.78 kB
# Wazuh Version Compatibility Guide
## Overview
This document details the compatibility of Wazuh MCP Server with different Wazuh versions, including supported features, API changes, and version-specific considerations.
---
## โ
**Supported Versions**
| Wazuh Version | Support Status | Recommendation | Notes |
|---------------|----------------|----------------|-------|
| **4.14.1** | โ
**Fully Supported** | **RECOMMENDED** | Latest stable release (Nov 2025) |
| **4.14.0** | โ
**Fully Supported** | Recommended | Stable release |
| **4.13.x** | โ
**Fully Supported** | Recommended | All 4.13 releases supported |
| **4.12.x** | โ
**Fully Supported** | Recommended | Includes CTI enhancements |
| **4.11.x** | โ
**Fully Supported** | Recommended | Stable release series |
| **4.10.x** | โ
**Fully Supported** | Recommended | Stable release series |
| **4.9.x** | โ
**Fully Supported** | Supported | Stable release series |
| **4.8.x** | โ
**Fully Supported** | Minimum Recommended | First version with Indexer API |
| **4.0.0 - 4.7.x** | โ ๏ธ **Limited Support** | Not Recommended | Legacy versions, limited features |
| **< 4.0.0** | โ **Not Supported** | Not Compatible | Use newer Wazuh version |
---
## ๐ฏ **Version-Specific Features**
### **Wazuh 4.14.1 (Latest - November 2025)**
**New Enhancements:**
- โ
IAM role support for VPC flow logs in AWS wodle
- โ
Static and temporary AWS credentials support in Amazon Security Lake
- โ
Enhanced wazuh-db startup performance
- โ
Improved vulnerability index upgrades with hash-based validation
- โ
Structured logging for indexer connector errors
- โ
Homebrew 2.0+ support in macOS IT Hygiene module
**Bug Fixes:**
- Fixed indefinite waiting in FIM whodata health checks
- Resolved manager vulnerability scanning trigger failures
- Corrected IndexerConnector data loss issues
- Fixed Windows Registry key recognition for non-UTF-8 keys
**API Compatibility:** โ
No breaking changes from 4.13.x
**MCP Server Support:** Fully tested and verified
### **Wazuh 4.13.x**
**Features:**
- Enhanced security monitoring capabilities
- Improved agent management
- Better vulnerability detection
**API Compatibility:** โ
Compatible with all MCP server endpoints
### **Wazuh 4.12.x**
**Key Features:**
- โ
**Cyber Threat Intelligence (CTI)** data integration
- โ
**Package condition fields** in vulnerability data
- โ
Enhanced CVE tracking and analysis
- โ
Improved vulnerability correlation
**New Endpoints:**
- `/vulnerability/cti/{cve_id}` - Get CTI data for specific CVEs
- Enhanced `/vulnerability/agents` response with CTI references
**MCP Server Support:**
- `get_cti_data()` - Fetch CTI information for CVEs
- `get_vulnerability_details()` - Enhanced vulnerability data
### **Wazuh 4.11.x**
**Features:**
- Improved cluster management
- Enhanced log analysis
- Better active response capabilities
**API Compatibility:** โ
Fully compatible
### **Wazuh 4.10.x**
**Features:**
- Enhanced syscollector data collection
- Improved FIM (File Integrity Monitoring)
- Better SCA (Security Configuration Assessment)
**API Compatibility:** โ
Fully compatible
### **Wazuh 4.9.x**
**Features:**
- Security enhancements
- Performance improvements
- Better agent connectivity
**API Compatibility:** โ
Fully compatible
### **Wazuh 4.8.x (Minimum Recommended)**
**Major Changes:**
- โ
**Wazuh Indexer API** introduced (replaces Elasticsearch)
- โ
**Centralized vulnerability detection**
- โ ๏ธ **Breaking Change:** `/vulnerability` endpoint removed
- โ ๏ธ **Breaking Change:** `custom` parameter removed from active response
- โ
New `/vulnerability/agents` endpoint
- โ
`/manager/version/check` endpoint added
**Migration from 4.7.x:**
- Update to use `/vulnerability/agents` instead of `/vulnerability`
- Remove `custom` parameter from active response calls
- Enable Wazuh Indexer for better performance
### **Wazuh 4.0.0 - 4.7.x (Limited Support)**
**Limitations:**
- โ ๏ธ No Wazuh Indexer support
- โ ๏ธ Uses deprecated `/vulnerability` endpoint
- โ ๏ธ Limited vulnerability detection capabilities
- โ ๏ธ Older API structure
**Recommendation:** Upgrade to 4.8.0 or higher
---
## ๐ง **Configuration by Version**
### **For Wazuh 4.8.0 - 4.14.1 (Recommended)**
```bash
# .env configuration
WAZUH_API_VERSION=v4
WAZUH_HOST=your-wazuh-server
WAZUH_PORT=55000
WAZUH_USER=your-user
WAZUH_PASS=your-password
VERIFY_SSL=true
# Enable Indexer (Required for 4.8.0+)
USE_INDEXER_FOR_ALERTS=true
USE_INDEXER_FOR_VULNERABILITIES=true
WAZUH_INDEXER_HOST=your-indexer-host
WAZUH_INDEXER_PORT=9200
WAZUH_INDEXER_USER=admin
WAZUH_INDEXER_PASS=admin
```
### **For Wazuh 4.0.0 - 4.7.x (Legacy)**
```bash
# .env configuration
WAZUH_API_VERSION=v4
WAZUH_HOST=your-wazuh-server
WAZUH_PORT=55000
WAZUH_USER=your-user
WAZUH_PASS=your-password
VERIFY_SSL=true
# Indexer NOT available in 4.7.x and below
USE_INDEXER_FOR_ALERTS=false
USE_INDEXER_FOR_VULNERABILITIES=false
```
---
## ๐ **API Endpoint Compatibility Matrix**
| Endpoint | 4.8-4.14.1 | 4.0-4.7.x | Notes |
|----------|------------|-----------|-------|
| `/agents` | โ
| โ
| Fully compatible across all versions |
| `/alerts` | โ
| โ
| Fully compatible |
| `/vulnerability/agents` | โ
| โ | Added in 4.8.0 |
| `/vulnerability` | โ | โ ๏ธ | Removed in 4.8.0, deprecated in 4.7.0 |
| `/vulnerability/cti/{cve}` | โ
| โ | Added in 4.12.0 |
| `/cluster/status` | โ
| โ
| Fully compatible |
| `/manager/stats` | โ
| โ
| Fully compatible |
| `/manager/version/check` | โ
| โ | Added in 4.8.0 |
| `/active-response` | โ
| โ ๏ธ | `custom` param removed in 4.8.0 |
| `/rules` | โ
| โ
| Fully compatible |
| `/decoders` | โ
| โ
| Fully compatible |
| `/syscheck` (FIM) | โ
| โ
| Fully compatible |
| `/syscollector` | โ
| โ
| Fully compatible |
---
## ๐ **Feature Availability**
### **Available in 4.8.0+**
- โ
Wazuh Indexer integration
- โ
Centralized vulnerability detection
- โ
Enhanced agent statistics
- โ
Improved cluster management
- โ
Version checking capabilities
### **Available in 4.12.0+**
- โ
Cyber Threat Intelligence (CTI) data
- โ
Package condition tracking
- โ
Enhanced CVE correlation
- โ
Advanced vulnerability analytics
### **Available in 4.14.0+**
- โ
AWS IAM role support
- โ
Amazon Security Lake integration
- โ
Enhanced vulnerability indexing
- โ
Improved error logging
---
## โ ๏ธ **Breaking Changes History**
### **4.8.0 Breaking Changes**
1. **Vulnerability Endpoint Removed**
- Old: `GET /vulnerability`
- New: `GET /vulnerability/agents`
- Impact: MCP Server automatically uses correct endpoint
2. **Active Response Parameter**
- Removed: `custom` parameter
- Impact: MCP Server filters this parameter automatically
### **No Breaking Changes in 4.9.0 - 4.14.1**
- All API endpoints remain compatible
- New features are additive only
- Backward compatibility maintained
---
## ๐ **Version Detection**
The MCP Server automatically detects your Wazuh version and adapts:
```python
# Example: Version-aware vulnerability fetching
async def get_vulnerabilities(self, **params):
# Automatically uses /vulnerability/agents for 4.8.0+
# Falls back to legacy endpoint for 4.7.x and below
return await self._request("GET", "/vulnerability/agents", params=params)
```
---
## ๐ **Upgrade Path**
### **From 4.0.x - 4.7.x to 4.8.0+**
1. **Backup your current Wazuh configuration**
2. **Upgrade Wazuh server to 4.8.0 or higher**
3. **Install Wazuh Indexer**
4. **Update MCP Server configuration:**
```bash
USE_INDEXER_FOR_ALERTS=true
USE_INDEXER_FOR_VULNERABILITIES=true
WAZUH_INDEXER_HOST=your-indexer
WAZUH_INDEXER_PORT=9200
```
5. **Restart MCP Server** - No code changes needed!
### **From 4.8.x - 4.13.x to 4.14.1**
- โ
**Direct upgrade** - No configuration changes needed
- โ
**Automatic compatibility** - MCP Server works immediately
- โ
**New features available** - AWS integrations and enhancements
---
## โ
**Testing & Verification**
### **Verify Compatibility**
```bash
# Check Wazuh version
curl -k -u user:password https://wazuh-server:55000/
# Test MCP Server health
curl http://localhost:3000/health
# Expected response includes:
{
"services": {
"wazuh": "healthy",
"mcp": "healthy"
}
}
```
### **Test Specific Features**
**For 4.14.1:**
```bash
# Test vulnerability detection
curl -X POST http://localhost:3000/mcp \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"tools/call","params":{"name":"get_wazuh_vulnerabilities"},"id":"1"}'
```
**For 4.12.0+:**
```bash
# Test CTI data
curl -X POST http://localhost:3000/mcp \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"tools/call","params":{"name":"get_cti_data","arguments":{"cve_id":"CVE-2024-1234"}},"id":"1"}'
```
---
## ๐ **Additional Resources**
- **Wazuh 4.14.1 Release Notes**: https://documentation.wazuh.com/current/release-notes/release-4-14-1.html
- **Wazuh API Documentation**: https://documentation.wazuh.com/current/user-manual/api/
- **Wazuh Upgrade Guide**: https://documentation.wazuh.com/current/upgrade-guide/
- **MCP Server Documentation**: README.md
---
## ๐ฏ **Recommendation Summary**
**For Production Use:**
- โ
**Use Wazuh 4.14.1** (latest stable)
- โ
**Minimum: Wazuh 4.8.0** (for full features)
- โ
**Enable Wazuh Indexer** (required for 4.8.0+)
- โ
**Keep both updated** (Wazuh + MCP Server)
**Compatibility Guarantee:**
This MCP Server is **fully tested and verified** with Wazuh versions 4.8.0 through 4.14.1, with ongoing support for future 4.x releases.