Zabbix Documentation 2.0

3.04.05.0 (current)| In development:5.2 (devel)| Unsupported:1.82.02.22.43.23.44.24.4Guidelines

User Tools

Site Tools


manual:appendix:api:api

Differences

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

Link to this comparison view

manual:appendix:api:api [2014/09/26 11:29]
sasha Links adapted because of a move operation
manual:appendix:api:api [2016/11/24 12:24]
Line 1: Line 1:
-===== Zabbix API ===== 
  
-The Zabbix API is a powerful tool for extending Zabbix, developing apps for your favorite platform or integrating it with third party software ​ 
- 
-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. 
- 
-[[history|History API]] 
- 
-=== Events === 
- 
-Retrieve events generated by triggers, network discovery and other Zabbix systems for more flexible situation management or third-party tool integration. 
- 
-[[event|Event API]] 
- 
-=== Service monitoring === 
- 
-Retrieve detailed service layer availability information about any IT service. 
- 
-[[manual:​appendix:​api:​service:​getsla|IT service SLA calculation]] 
- 
-==== 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|Host API]] | [[hostgroup|Host group API]] | [[hostinterface|Host interface API]] |  
-[[usermacro|User macro API]] |  
-[[maintenance|Maintenance API]] 
- 
-=== Items and applications === 
- 
-Define items to monitor. Create or remove applications and assign items to them. 
- 
-[[item|Item API]] | [[application|Application API]] 
- 
-=== Triggers === 
- 
-Configure triggers to notify you about problems in your system. Manage trigger dependencies. 
- 
-[[trigger|Trigger API]] 
- 
-=== Graphs === 
- 
-Edit graphs or separate graph items for better presentation of the gathered data. 
- 
-[[graph|Graph API]] | [[graphitem|Graph item API]] 
- 
-=== Templates === 
- 
-Manage templates and link them to hosts or other templates. 
- 
-[[template|Template API]] 
- 
-=== Export and import === 
- 
-Export and import Zabbix configuration data for configuration backups, migration or large-scale configuration updates. 
- 
-[[configuration|Configuration API]] 
- 
-=== Low-level discovery === 
- 
-Configure low-level discovery rules as well as item, trigger and graph prototypes to monitor dynamic entities. 
- 
-[[discoveryrule|LLD rule API]] | [[itemprototype|Item prototype API]] | [[triggerprototype|Trigger protototype API]] | [[graphprototype|Graph prototype API]] 
- 
-=== Screens === 
- 
-Edit global and template-level screens or each screen item individually. 
- 
-[[screen|Screen API]] | [[screenitem|Screen item API]] | [[templatescreen|Template screen API]] | [[templatescreenitem|Template screen item 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. 
- 
-[[action|Action API]] | [[alert|Alert API]] 
- 
-=== IT services ==== 
- 
-Manage IT services for service-level monitoring and retrieve detailed SLA information about any service. 
- 
-[[service|IT service API]] 
- 
-=== Maps === 
- 
-Configure maps to create detailed dynamic representations of your IT infrastructure. 
- 
-[[map|Map API]] 
- 
-=== Web monitoring === 
- 
-Configure web scenarios to monitor your web applications and services. 
- 
-[[webcheck|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. 
- 
-[[drule|Discovery rule API]] | [[dcheck|Discovery check API]] | [[dhost|Discovery host API]] | [[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. 
- 
-[[user|User API]] | [[usergroup|User group API]] | [[mediatype|Media type API]] | [[usermedia|Media API]] 
- 
-=== General === 
- 
-Change certain global configuration options. 
- 
-[[iconmap|Icon map API]] | [[image|Image API]] | [[usermacro|User macro API]] 
- 
-=== Proxies === 
- 
-Manage the proxies used in your distributed monitoring setup. 
- 
-[[proxy|Proxy API]] 
- 
-=== Scripts === 
- 
-Configure and execute scripts to help you with your daily tasks. 
- 
-[[script|Script API]] 
- 
-==== API information ==== 
- 
-Retrieve the version of the Zabbix API so that your application could use version-specific features. 
- 
-[[apiinfo|API info API]]