manual:api:reference

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Previous revision
Last revision Both sides next revision
manual:api:reference [2016/11/24 12:24]
manual:api:reference [2018/10/01 09:42]
127.0.0.1 external edit
Line 1: Line 1:
 +===== 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.
 +
 +=== History ===
 +
 +Retrieve historical values gathered by Zabbix monitoring processes for presentation or further processing.
 +
 +[[manual:​api:​reference:​history|History API]]
 +
 +=== Trends ===
 +
 +Retrieve trend values calculated by Zabbix server for presentation or further processing.
 +
 +[[manual:​api:​reference:​trend|Trend API]]
 +
 +=== Events ===
 +
 +Retrieve events generated by triggers, network discovery and other Zabbix systems for more flexible situation management or third-party tool integration.
 +
 +[[manual:​api:​reference:​event|Event API]]
 +
 +=== Problems ===
 +
 +Retrieve problems according to the given parameters.
 +
 +[[manual:​api:​reference:​problem|Problem API]]
 +
 +=== Service monitoring ===
 +
 +Retrieve detailed service layer availability information about any service.
 +
 +[[manual:​api:​reference:​service:​getsla|Service SLA calculation]]
 +
 +=== Tasks ===
 +
 +Task manager allows to check items or low-level discovery rules without config reload.
 +
 +[[manual:​api:​reference:​task|Task API]]
 +
 +==== 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.
 +
 +[[manual:​api:​reference:​host|Host API]] | [[manual:​api:​reference:​hostgroup|Host group API]] | [[manual:​api:​reference:​hostinterface|Host interface API]] | 
 +[[manual:​api:​reference:​usermacro|User macro API]] | 
 +[[manual:​api:​reference:​maintenance|Maintenance API]]
 +
 +=== Items and applications ===
 +
 +Define items to monitor. Create or remove applications and assign items to them.
 +
 +[[manual:​api:​reference:​item|Item API]] | [[manual:​api:​reference:​application|Application API]]
 +
 +=== Triggers ===
 +
 +Configure triggers to notify you about problems in your system. Manage trigger dependencies.
 +
 +[[manual:​api:​reference:​trigger|Trigger API]]
 +
 +=== Graphs ===
 +
 +Edit graphs or separate graph items for better presentation of the gathered data.
 +
 +[[manual:​api:​reference:​graph|Graph API]] | [[manual:​api:​reference:​graphitem|Graph item API]]
 +
 +=== Templates ===
 +
 +Manage templates and link them to hosts or other templates.
 +
 +[[manual:​api:​reference:​template|Template API]]
 +
 +=== Export and import ===
 +
 +Export and import Zabbix configuration data for configuration backups, migration or large-scale configuration updates.
 +
 +[[manual:​api:​reference:​configuration|Configuration API]]
 +
 +=== Low-level discovery ===
 +
 +Configure low-level discovery rules as well as item, trigger and graph prototypes to monitor dynamic entities.
 +
 +[[manual:​api:​reference:​discoveryrule|LLD rule API]] | [[manual:​api:​reference:​itemprototype|Item prototype API]] | [[manual:​api:​reference:​triggerprototype|Trigger protototype API]] | [[manual:​api:​reference:​graphprototype|Graph prototype API]] | [[manual:​api:​reference:​hostprototype|Host prototype API]] 
 +
 +=== Event correlation ===
 +
 +Create custom event correlation rules.
 +
 +[[manual:​api:​reference:​correlation|Correlation API]]
 +
 +=== 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.
 +
 +[[manual:​api:​reference:​action|Action API]] | [[manual:​api:​reference:​alert|Alert API]]
 +
 +=== Services ====
 +
 +Manage services for service-level monitoring and retrieve detailed SLA information about any service.
 +
 +[[manual:​api:​reference:​service|Service API]]
 +
 +=== Dashboards ===
 +
 +Manage dashboards.
 +
 +[[manual:​api:​reference:​dashboard|Dashboard API]]
 +
 +=== Screens ===
 +
 +Edit global and template-level screens or each screen item individually.
 +
 +[[manual:​api:​reference:​screen|Screen API]] | [[manual:​api:​reference:​screenitem|Screen item API]] | [[manual:​api:​reference:​templatescreen|Template screen API]] | [[manual:​api:​reference:​templatescreenitem|Template screen item API]]
 +
 +=== Maps ===
 +
 +Configure maps to create detailed dynamic representations of your IT infrastructure.
 +
 +[[manual:​api:​reference:​map|Map API]]
 +
 +=== Web monitoring ===
 +
 +Configure web scenarios to monitor your web applications and services.
 +
 +[[manual:​api:​reference:​httptest|Web scenario API]]
 +
 +=== Network discovery ====
 +
 +Manage network-level discovery rules to automatically find and monitor new hosts. Gain full access to information about discovered services and hosts.
 +
 +[[manual:​api:​reference:​drule|Discovery rule API]] | [[manual:​api:​reference:​dcheck|Discovery check API]] | [[manual:​api:​reference:​dhost|Discovery host API]] | [[manual:​api:​reference:​dservice|Discovery 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. Configure media types and the ways users will receive alerts.
 +
 +[[manual:​api:​reference:​user|User API]] | [[manual:​api:​reference:​usergroup|User group API]] | [[manual:​api:​reference:​mediatype|Media type API]]
 +=== General ===
 +
 +Change certain global configuration options.
 +
 +[[manual:​api:​reference:​iconmap|Icon map API]] | [[manual:​api:​reference:​image|Image API]] | [[manual:​api:​reference:​usermacro|User macro API]]
 +
 +=== Proxies ===
 +
 +Manage the proxies used in your distributed monitoring setup.
 +
 +[[manual:​api:​reference:​proxy|Proxy API]]
 +
 +=== Scripts ===
 +
 +Configure and execute scripts to help you with your daily tasks.
 +
 +[[manual:​api:​reference:​script|Script API]]
 +
 +==== API information ====
 +
 +Retrieve the version of the Zabbix API so that your application could use version-specific features.
 +
 +[[manual:​api:​reference:​apiinfo|API info API]]