Zabbix Documentation 4.4

3.04.04.4 (current)| In development:5.0 (devel)| Unsupported:1.82.02.22.43.23.44.2Guidelines

User Tools

Site Tools


manual:api:reference

Differences

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

Link to this comparison view

Next revision
Previous revision
manual:api:reference [2014/09/25 14:42]
sasha Page moved from 2.4:manual:api:reference to manual:api:reference
manual:api:reference [2020/01/15 02:59] (current)
[email protected] [General]
Line 11: Line 11:
 Retrieve historical values gathered by Zabbix monitoring processes for presentation or further processing. Retrieve historical values gathered by Zabbix monitoring processes for presentation or further processing.
  
-[[2.4:manual:​api:​reference:​history|History API]]+[[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 === === Events ===
Line 17: Line 23:
 Retrieve events generated by triggers, network discovery and other Zabbix systems for more flexible situation management or third-party tool integration. Retrieve events generated by triggers, network discovery and other Zabbix systems for more flexible situation management or third-party tool integration.
  
-[[2.4:manual:​api:​reference:​event|Event API]]+[[manual:​api:​reference:​event|Event ​API]] 
 + 
 +=== Problems === 
 + 
 +Retrieve problems according to the given parameters. 
 + 
 +[[manual:​api:​reference:​problem|Problem ​API]]
  
 === Service monitoring === === Service monitoring ===
  
-Retrieve detailed service layer availability information about any IT service.+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.
  
-[[2.4:manual:​api:​reference:​service:​getsla|IT service SLA calculation]]+[[manual:​api:​reference:​task|Task API]]
  
 ==== Configuration ==== ==== Configuration ====
Line 33: Line 51:
 Manage host groups, hosts and everything related to them, including host interfaces, host macros and maintenance periods. Manage host groups, hosts and everything related to them, including host interfaces, host macros and maintenance periods.
  
-[[2.4:manual:​api:​reference:​host|Host API]] | [[2.4:manual:​api:​reference:​hostgroup|Host group API]] | [[2.4:manual:​api:​reference:​hostinterface|Host interface API]] |  +[[manual:​api:​reference:​host|Host API]] | [[manual:​api:​reference:​hostgroup|Host group API]] | [[manual:​api:​reference:​hostinterface|Host interface API]] |  
-[[2.4:manual:​api:​reference:​usermacro|User macro API]] |  +[[manual:​api:​reference:​usermacro|User macro API]] |  
-[[2.4:manual:​api:​reference:​maintenance|Maintenance API]]+[[manual:​api:​reference:​maintenance|Maintenance API]]
  
 === Items and applications === === Items and applications ===
Line 41: Line 59:
 Define items to monitor. Create or remove applications and assign items to them. Define items to monitor. Create or remove applications and assign items to them.
  
-[[2.4:manual:​api:​reference:​item|Item API]] | [[2.4:manual:​api:​reference:​application|Application API]]+[[manual:​api:​reference:​item|Item API]] | [[manual:​api:​reference:​application|Application API]]
  
 === Triggers === === Triggers ===
Line 47: Line 65:
 Configure triggers to notify you about problems in your system. Manage trigger dependencies. Configure triggers to notify you about problems in your system. Manage trigger dependencies.
  
-[[2.4:manual:​api:​reference:​trigger|Trigger API]]+[[manual:​api:​reference:​trigger|Trigger API]]
  
 === Graphs === === Graphs ===
Line 53: Line 71:
 Edit graphs or separate graph items for better presentation of the gathered data. Edit graphs or separate graph items for better presentation of the gathered data.
  
-[[2.4:manual:​api:​reference:​graph|Graph API]] | [[2.4:manual:​api:​reference:​graphitem|Graph item API]]+[[manual:​api:​reference:​graph|Graph API]] | [[manual:​api:​reference:​graphitem|Graph item API]]
  
 === Templates === === Templates ===
Line 59: Line 77:
 Manage templates and link them to hosts or other templates. Manage templates and link them to hosts or other templates.
  
-[[2.4:manual:​api:​reference:​template|Template API]]+[[manual:​api:​reference:​template|Template API]]
  
 === Export and import === === Export and import ===
Line 65: Line 83:
 Export and import Zabbix configuration data for configuration backups, migration or large-scale configuration updates. Export and import Zabbix configuration data for configuration backups, migration or large-scale configuration updates.
  
-[[2.4:manual:​api:​reference:​configuration|Configuration API]]+[[manual:​api:​reference:​configuration|Configuration API]]
  
 === Low-level discovery === === Low-level discovery ===
Line 71: Line 89:
 Configure low-level discovery rules as well as item, trigger and graph prototypes to monitor dynamic entities. Configure low-level discovery rules as well as item, trigger and graph prototypes to monitor dynamic entities.
  
-[[2.4:manual:​api:​reference:​discoveryrule|LLD rule API]] | [[2.4:manual:​api:​reference:​itemprototype|Item prototype API]] | [[2.4:manual:​api:​reference:​triggerprototype|Trigger protototype API]] | [[2.4:manual:​api:​reference:​graphprototype|Graph prototype API]] | [[2.4:manual:​api:​reference:​hostprototype|Host prototype API]]  +[[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]] 
-=== Screens ===+
  
-Edit global and template-level screens or each screen item individually.+=== Event correlation ===
  
-[[2.4:​manual:​api:​reference:​screen|Screen API]] | [[2.4:​manual:​api:​reference:​screenitem|Screen item API]] | [[2.4:​manual:​api:​reference:​templatescreen|Template screen API]] | [[2.4:manual:​api:​reference:​templatescreenitem|Template screen item API]]+Create custom event correlation rules. 
 + 
 +[[manual:​api:​reference:​correlation|Correlation ​API]]
  
 === Actions and alerts === === Actions and alerts ===
Line 82: Line 101:
 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. 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.
  
-[[2.4:manual:​api:​reference:​action|Action API]] | [[2.4:manual:​api:​reference:​alert|Alert API]]+[[manual:​api:​reference:​action|Action API]] | [[manual:​api:​reference:​alert|Alert API]]
  
-=== IT services ​====+=== Services ​====
  
-Manage ​IT services for service-level monitoring and retrieve detailed SLA information about any service.+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.
  
-[[2.4:​manual:​api:​reference:​service|IT service ​API]]+[[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 === === Maps ===
Line 94: Line 125:
 Configure maps to create detailed dynamic representations of your IT infrastructure. Configure maps to create detailed dynamic representations of your IT infrastructure.
  
-[[2.4:manual:​api:​reference:​map|Map API]]+[[manual:​api:​reference:​map|Map API]]
  
 === Web monitoring === === Web monitoring ===
Line 100: Line 131:
 Configure web scenarios to monitor your web applications and services. Configure web scenarios to monitor your web applications and services.
  
-[[2.4:manual:​api:​reference:​httptest|Web scenario API]]+[[manual:​api:​reference:​httptest|Web scenario API]]
  
 === Network discovery ==== === Network discovery ====
Line 106: Line 137:
 Manage network-level discovery rules to automatically find and monitor new hosts. Gain full access to information about discovered services and hosts. Manage network-level discovery rules to automatically find and monitor new hosts. Gain full access to information about discovered services and hosts.
  
-[[2.4:manual:​api:​reference:​drule|Discovery rule API]] | [[2.4:manual:​api:​reference:​dcheck|Discovery check API]] | [[2.4:manual:​api:​reference:​dhost|Discovery host API]] | [[2.4:manual:​api:​reference:​dservice|Discovery service API]]+[[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 ==== ==== Administration ====
Line 116: Line 147:
 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. 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.
  
-[[2.4:manual:​api:​reference:​user|User API]] | [[2.4:manual:​api:​reference:​usergroup|User group API]] | [[2.4:manual:​api:​reference:​mediatype|Media type API]] | [[2.4:​manual:​api:​reference:​usermedia|Media API]] +[[manual:​api:​reference:​user|User API]] | [[manual:​api:​reference:​usergroup|User group API]] | [[manual:​api:​reference:​mediatype|Media type API]]
 === General === === General ===
  
 Change certain global configuration options. Change certain global configuration options.
  
-[[2.4:​manual:​api:​reference:​iconmap|Icon map API]] | [[2.4:manual:​api:​reference:​image|Image API]] | [[2.4:manual:​api:​reference:​usermacro|User macro API]]+[[manual:api:​reference:​autoregistration|Auto registration API]] | [[manual:​api:​reference:​iconmap|Icon map API]] | [[manual:​api:​reference:​image|Image API]] | [[manual:​api:​reference:​usermacro|User macro API]] | [[manual:​api:​reference:​valuemap|Value map API]]
  
 === Proxies === === Proxies ===
Line 128: Line 158:
 Manage the proxies used in your distributed monitoring setup. Manage the proxies used in your distributed monitoring setup.
  
-[[2.4:manual:​api:​reference:​proxy|Proxy API]]+[[manual:​api:​reference:​proxy|Proxy API]]
  
 === Scripts === === Scripts ===
Line 134: Line 164:
 Configure and execute scripts to help you with your daily tasks. Configure and execute scripts to help you with your daily tasks.
  
-[[2.4:manual:​api:​reference:​script|Script API]]+[[manual:​api:​reference:​script|Script API]]
  
 ==== API information ==== ==== API information ====
Line 140: Line 170:
 Retrieve the version of the Zabbix API so that your application could use version-specific features. Retrieve the version of the Zabbix API so that your application could use version-specific features.
  
-[[2.4:manual:​api:​reference:​apiinfo|API info API]]+[[manual:​api:​reference:​apiinfo|API info API]]