Zabbix integration¶
Connect DXDT to Zabbix with a read-only API token so the platform can query hosts, problems, and monitoring data via the JSON-RPC API. DXDT only reads.
| Setup time | ~8 minutes |
| Difficulty | Easy |
Access required: Zabbix API token for a read-only user role
Prerequisites¶
- Zabbix 5.4 or newer (API tokens were added in 5.4)
- A user in a role/user group with read-only permissions to the relevant host groups
- Your Zabbix frontend URL
Setup¶
1. Use a read-only user¶
Create or choose a Zabbix user assigned to a user group with read-only permissions on the host groups DXDT should see. Avoid Super admin; a User-type role with read permissions is ideal.
Note
Least privilege: DXDT only needs to read monitoring data.
2. Create an API token¶
In the Zabbix frontend go to Users → API tokens, click Create API token, assign it to the read-only user, and save. Copy the token value — it is shown only once.
- Open Users → API tokens
- Click Create API token
- Assign it to the read-only user and copy the token
3. Identify your Zabbix URL¶
Your zabbix_url is the Zabbix frontend base URL, e.g. https://zabbix.example.com or https://zabbix.example.com/zabbix. Do not append /api_jsonrpc.php — DXDT adds it automatically.
Note
DXDT builds the JSON-RPC endpoint by appending /api_jsonrpc.php to this base.
4. Enter the values in DXDT¶
In the plugin Configuration tab, paste API Token and Zabbix URL and save. DXDT validates the credentials on install.
Configuration fields¶
| Field | Where to find it |
|---|---|
API Token (api_token) |
The token from Users → API tokens → Create API token, bound to a read-only user. |
Zabbix URL (zabbix_url) |
Your Zabbix frontend base URL (e.g. https://zabbix.example.com); DXDT appends /api_jsonrpc.php. |
Verify the connection¶
Save on the Configuration tab and confirm the Live Status panel is healthy; DXDT validates the token on install and reports the Zabbix API version and host count.
Security
Credentials are stored encrypted per-tenant and used only for read-only Zabbix JSON-RPC calls.
Troubleshooting¶
Authentication / "Not authorized" error
Invalid or revoked API token. Recreate the API token under Users → API tokens and re-enter it.
Connection fails or 404
Wrong zabbix_url, or /api_jsonrpc.php was appended manually. Use the frontend base URL only; DXDT adds /api_jsonrpc.php for you.
Empty host or problem lists
The token's user lacks read permission on those host groups. Grant the user's group read access to the relevant host groups.
API tokens option not available
Zabbix version is older than 5.4. Upgrade to Zabbix 5.4+ to use API tokens.
Vendor documentation: https://www.zabbix.com/documentation/current/en/manual/web_interface/frontend_sections/users/api_tokens