[comment]: # ({b0d207c5-b0d207c5}) # 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. [comment]: # ({/b0d207c5-b0d207c5}) [comment]: # ({84120a97-53edf72e}) ## Monitoring The Zabbix API allows you to access history and other data gathered during monitoring. [comment]: # ({/84120a97-53edf72e}) [comment]: # ({1a3dcbcf-1a3dcbcf}) #### Dashboards Manage dashboards and make scheduled reports based on them. [Dashboard API](/manual/api/reference/dashboard) | [Template dashboard API](/manual/api/reference/templatedashboard) | [Report API](/manual/api/reference/report) [comment]: # ({/1a3dcbcf-1a3dcbcf}) [comment]: # ({ead86ed5-ead86ed5}) #### High availability cluster Retrieve a list of server nodes and their status. [High availability cluster API](/manual/api/reference/hanode) [comment]: # ({/ead86ed5-ead86ed5}) [comment]: # ({46aecf9d-46aecf9d}) #### History Retrieve historical values gathered by Zabbix monitoring processes for presentation or further processing. [History API](/manual/api/reference/history) [comment]: # ({/46aecf9d-46aecf9d}) [comment]: # ({ce08707b-ce08707b}) #### Trends Retrieve trend values calculated by Zabbix server for presentation or further processing. [Trend API](/manual/api/reference/trend) [comment]: # ({/ce08707b-ce08707b}) [comment]: # ({4e280d13-4e280d13}) #### Events Retrieve events generated by triggers, network discovery and other Zabbix systems for more flexible situation management or third-party tool integration. [Event API](/manual/api/reference/event) [comment]: # ({/4e280d13-4e280d13}) [comment]: # ({087f1047-087f1047}) #### Problems Retrieve problems according to the given parameters. [Problem API](/manual/api/reference/problem) [comment]: # ({/087f1047-087f1047}) [comment]: # ({29b6c9a4-29b6c9a4}) #### Maps Configure maps to create detailed dynamic representations of your IT infrastructure. [Map API](/manual/api/reference/map) [comment]: # ({/29b6c9a4-29b6c9a4}) [comment]: # ({ea863fe1-ea863fe1}) #### Tasks Interact with Zabbix server task manager, creating tasks and retrieving response. [Task API](/manual/api/reference/task) [comment]: # ({/ea863fe1-ea863fe1}) [comment]: # ({2fae33fd-services}) ## Services The Zabbix API allows you to access data gathered during service monitoring. [comment]: # ({/2fae33fd-services}) [comment]: # ({2b35beaa-2b35beaa}) #### Service Level Agreement Define Service Level Objectives (SLO), retrieve detailed Service Level Indicators (SLI) information about service performance. [SLA API](/manual/api/reference/sla) [comment]: # ({/2b35beaa-2b35beaa}) [comment]: # ({891cbcad-891cbcad}) #### Services Manage services for service-level monitoring and retrieve detailed SLA information about any service. [Service API](/manual/api/reference/service) [comment]: # ({/891cbcad-891cbcad}) [comment]: # ({3ca050b4-467838af}) ## Data collection The Zabbix API allows you to manage the configuration of your monitoring system. [comment]: # ({/3ca050b4-467838af}) [comment]: # ({4fe0de77-4fe0de77}) #### Hosts and host groups Manage host groups, hosts and everything related to them, including host interfaces, host macros and maintenance periods. [Host API](/manual/api/reference/host) | [Host group API](/manual/api/reference/hostgroup) | [Host interface API](/manual/api/reference/hostinterface) | [User macro API](/manual/api/reference/usermacro) | [Value map API](/manual/api/reference/valuemap) | [Maintenance API](/manual/api/reference/maintenance) [comment]: # ({/4fe0de77-4fe0de77}) [comment]: # ({29ae0d97-29ae0d97}) #### Items Define items to monitor. [Item API](/manual/api/reference/item) [comment]: # ({/29ae0d97-29ae0d97}) [comment]: # ({de0198b3-de0198b3}) #### Triggers Configure triggers to notify you about problems in your system. Manage trigger dependencies. [Trigger API](/manual/api/reference/trigger) [comment]: # ({/de0198b3-de0198b3}) [comment]: # ({f61b98cf-f61b98cf}) #### Graphs Edit graphs or separate graph items for better presentation of the gathered data. [Graph API](/manual/api/reference/graph) | [Graph item API](/manual/api/reference/graphitem) [comment]: # ({/f61b98cf-f61b98cf}) [comment]: # ({e61f3b03-7a170077}) #### Templates and template groups Manage templates and link them to hosts or other templates. [Template API](/manual/api/reference/template) | [Template group API](/manual/api/reference/templategroup) | [Value map API](/manual/api/reference/valuemap) [comment]: # ({/e61f3b03-7a170077}) [comment]: # ({61993c62-61993c62}) #### Low-level discovery Configure low-level discovery rules as well as item, trigger and graph prototypes to monitor dynamic entities. [LLD rule API](/manual/api/reference/discoveryrule) | [Item prototype API](/manual/api/reference/itemprototype) | [Trigger prototype API](/manual/api/reference/triggerprototype) | [Graph prototype API](/manual/api/reference/graphprototype) | [Host prototype API](/manual/api/reference/hostprototype) [comment]: # ({/61993c62-61993c62}) [comment]: # ({63c25731-63c25731}) #### Event correlation Create custom event correlation rules. [Correlation API](/manual/api/reference/correlation) [comment]: # ({/63c25731-63c25731}) [comment]: # ({91788676-91788676}) #### 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](/manual/api/reference/drule) | [Discovery check API](/manual/api/reference/dcheck) | [Discovered host API](/manual/api/reference/dhost) | [Discovered service API](/manual/api/reference/dservice) [comment]: # ({/91788676-91788676}) [comment]: # ({56f63ece-56f63ece}) #### Export and import Export and import Zabbix configuration data for configuration backups, migration or large-scale configuration updates. [Configuration API](/manual/api/reference/configuration) [comment]: # ({/56f63ece-56f63ece}) [comment]: # ({e083e0e0-e083e0e0}) #### Web monitoring Configure web scenarios to monitor your web applications and services. [Web scenario API](/manual/api/reference/httptest) [comment]: # ({/e083e0e0-e083e0e0}) [comment]: # ({21240961-alerts}) ## Alerts The Zabbix API allows you to manage the actions and alerts of your monitoring system. [comment]: # ({/21240961-alerts}) [comment]: # ({3ea1b33b-3ea1b33b}) #### 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 API](/manual/api/reference/action) | [Alert API](/manual/api/reference/alert) [comment]: # ({/3ea1b33b-3ea1b33b}) [comment]: # ({db21e75f-media}) #### Media types Configure media types and multiple ways users will receive alerts. [Media type API](/manual/api/reference/mediatype) [comment]: # ({/db21e75f-media}) [comment]: # ({4e5421dd-4e5421dd}) #### Scripts Configure and execute scripts to help you with your daily tasks. [Script API](/manual/api/reference/script) [comment]: # ({/4e5421dd-4e5421dd}) [comment]: # ({9b5ff098-users}) ## Users The Zabbix API allows you to manage users of your monitoring system. [comment]: # ({/9b5ff098-users}) [comment]: # ({efe6ebed-c2d096e3}) #### Users and user groups Add users that will have access to Zabbix, assign them to user groups and grant permissions. Make roles for granular management of user rights. [User API](/manual/api/reference/user) | [User group API](/manual/api/reference/usergroup) | [User directory API](/manual/api/reference/userdirectory) | [User role API](/manual/api/reference/role) [comment]: # ({/efe6ebed-c2d096e3}) [comment]: # ({4050de56-4050de56}) #### API Tokens Manage authorization tokens. [Token API](/manual/api/reference/token) [comment]: # ({/4050de56-4050de56}) [comment]: # ({a1c36c8e-a1c36c8e}) #### Authentication Change authentication configuration options. [Authentication API](/manual/api/reference/authentication) [comment]: # ({/a1c36c8e-a1c36c8e}) [comment]: # ({1df017e9-ad3cb7b9}) ## Administration With the Zabbix API you can change administration settings of your monitoring system. [comment]: # ({/1df017e9-ad3cb7b9}) [comment]: # ({6897171d-925840a1}) #### General Change certain global configuration options. [Autoregistration API](/manual/api/reference/autoregistration) | [Icon map API](/manual/api/reference/iconmap) | [Image API](/manual/api/reference/image) | [Settings API](/manual/api/reference/settings) | [Regular expression API](/manual/api/reference/regexp) | [Module API](/manual/api/reference/module) | [Connector API](/manual/api/reference/connector) [comment]: # ({/6897171d-925840a1}) [comment]: # ({7f66a89c-audit}) #### Audit log Track configuration changes each user has done. [Audit log API](/manual/api/reference/auditlog) [comment]: # ({/7f66a89c-audit}) [comment]: # ({92411ee5-housekeeping}) #### Housekeeping Configure housekeeping. [Housekeeping API](/manual/api/reference/housekeeping) [comment]: # ({/92411ee5-housekeeping}) [comment]: # ({ca8a8603-feb914d9}) #### Proxies and proxy groups Manage the proxies used in your distributed monitoring setup. [Proxy API](/manual/api/reference/proxy) | [Proxy group API](/manual/api/reference/proxygroup) [comment]: # ({/ca8a8603-feb914d9}) [comment]: # ({c91a6fe3-macros}) #### Macros Manage macros. [User macro API](/manual/api/reference/usermacro) [comment]: # ({/c91a6fe3-macros}) [comment]: # ({3b3700b0-3b3700b0}) ### API information Retrieve the version of the Zabbix API so that your application could use version-specific features. [API info API](/manual/api/reference/apiinfo) [comment]: # ({/3b3700b0-3b3700b0})