Zabbix
Collect your monitored hosts inventory and alerts from Zabbix
The Zabbix connector allows you to centralize your monitored hosts inventory, alerts and performance metrics from your Zabbix platform.
Objective
The Zabbix connector retrieves the following information:
- Monitored hosts inventory
- Active alerts and triggers
- Performance metrics and historical data
Prerequisites
- Access to Zabbix with API rights
- Zabbix API key OR username/password credentials
Information to provide in OverSOC
| Field | Description |
|---|---|
| API URL* | URL of the Zabbix API (e.g., https://zabbix.example.com/api_jsonrpc.php) |
| API Key | Zabbix API key (optional if username/password provided) |
| Username | Zabbix username (optional if API Key provided) |
| Password | Zabbix password (optional if API Key provided) |
*Required fields - At minimum: API URL + (API Key OR Username/Password)
Procedure
Option 1: Use an API token (Zabbix 6.0+)
- Log in to Zabbix with an administrator account.
- Go to Administration > General > API tokens.
- Click Create API token.
- Name the token
OverSOCwith appropriate expiration. - Select the required permissions:
- Read access to hosts
- Read access to alerts/triggers
- Read access to history
- Click Create and copy the generated token.
Option 2: Use username/password
- Create a dedicated user in Zabbix:
- Username:
oversoc-api - Password: Generate a strong password
- Username:
- Assign the appropriate role with read permissions.
- Record the credentials.
Configure the connector in OverSOC
- In OverSOC, go to Data Sources Settings > Sources.
- Select Zabbix and click Configure.
- Fill in the fields:
- API URL: Complete URL of the Zabbix API
- API Key: Generated API token (if used)
- Username: Zabbix username (if used)
- Password: Zabbix password (if used)
- Click Test Connection to verify the connection.
- Click Save Configuration.
View Zabbix API tokens documentation
Required Permissions
Minimum required permissions:
- Read hosts and configurations
- Read alerts and triggers
- Access to historical data and metrics
- Read performance information