Table of Contents
Method reference
This section provides an overview of the functions provided by the Zabbix API and will help you find your way around the available classes and methods.
Monitoring
The Zabbix API allows you to access history and other data gathered during monitoring.
High availability cluster
Retrieve a list of server nodes and their status.
History
Retrieve historical values gathered by Zabbix monitoring processes for presentation or further processing.
Trends
Retrieve trend values calculated by Zabbix server for presentation or further processing.
Events
Retrieve events generated by triggers, network discovery and other Zabbix systems for more flexible situation management or third-party tool integration.
Problems
Retrieve problems according to the given parameters.
Service monitoring
Create a hierarchy representation of monitored IT infrastructure/business services data.
Service Level Agreement
Define Service Level Objectives (SLO), retrieve detailed Service Level Indicators (SLI) information about service performance.
Tasks
Interact with Zabbix server task manager, creating tasks and retrieving response.
Configuration
The Zabbix API allows you to manage the configuration of your monitoring system.
Hosts and host groups
Manage host groups, hosts and everything related to them, including host interfaces, host macros and maintenance periods.
Host API | Host group API | Host interface API | User macro API | Value map API | Maintenance API
Items
Define items to monitor.
Triggers
Configure triggers to notify you about problems in your system. Manage trigger dependencies.
Graphs
Edit graphs or separate graph items for better presentation of the gathered data.
Templates
Manage templates and link them to hosts or other templates.
Export and import
Export and import Zabbix configuration data for configuration backups, migration or large-scale configuration updates.
Low-level discovery
Configure low-level discovery rules as well as item, trigger and graph prototypes to monitor dynamic entities.
LLD rule API | Item prototype API | Trigger prototype API | Graph prototype API | Host prototype API
Event correlation
Create custom event correlation rules.
Actions and alerts
Define actions and operations to notify users about certain events or automatically execute remote commands. Gain access to information about generated alerts and their receivers.
Services
Manage services for service-level monitoring and retrieve detailed SLA information about any service.
Dashboards
Manage dashboards and make scheduled reports based on them.
Dashboard API | Template dashboard API | Report API
Maps
Configure maps to create detailed dynamic representations of your IT infrastructure.
Web monitoring
Configure web scenarios to monitor your web applications and services.
Network discovery
Manage network-level discovery rules to automatically find and monitor new hosts. Gain full access to information about discovered services and hosts.
Discovery rule API | Discovery check API | Discovered host API | Discovered service API
Administration
With the Zabbix API you can change administration settings of your monitoring system.
Users
Add users that will have access to Zabbix, assign them to user groups and grant permissions. Make roles for granular management of user rights. Track configuration changes each user has done. Configure media types and multiple ways users will receive alerts.
User API | User group API | User role API | Media type API | Audit log API
General
Change certain global configuration options.
Autoregistration API | Icon map API | Image API | User macro API | Settings API | Housekeeping API
Regular expressions
Manage global regular expressions.
Proxies
Manage the proxies used in your distributed monitoring setup.
Authentication
Change authentication configuration options.
API Tokens
Manage authorization tokens.
Scripts
Configure and execute scripts to help you with your daily tasks.
API information
Retrieve the version of the Zabbix API so that your application could use version-specific features.