Documentation

This is the documentation page for an unsupported version of Zabbix.
Is this not what you were looking for? Switch to the current version or choose one from the drop-down menu.
1 Frontend improvements
1 Manual structure
2 What is Zabbix
3 Zabbix features
4 Zabbix overview
5 What's new in Zabbix 2.0.0
6 What's new in Zabbix 2.0.1
7 What's new in Zabbix 2.0.2
8 What's new in Zabbix 2.0.3
9 What's new in Zabbix 2.0.4
10 What's new in Zabbix 2.0.5
11 What's new in Zabbix 2.0.6
12 What's new in Zabbix 2.0.7
13 What's new in Zabbix 2.0.8
14 What's new in Zabbix 2.0.9
15 What's new in Zabbix 2.0.10
16 What's new in Zabbix 2.0.11
17 What's new in Zabbix 2.0.12
18 What's new in Zabbix 2.0.13
19 What's new in Zabbix 2.0.14
20 What's new in Zabbix 2.0.15
21 What's new in Zabbix 2.0.16
22 What's new in Zabbix 2.0.17
1 Zabbix definitions
2 Server
3 Agent
4 Proxy
5 Java gateway
6 Sender
7 Get
1 Getting Zabbix
2 Requirements
3 Installation from packages
4 Installation from sources
5 Known issues
6 Upgrade procedure
7 Upgrade notes for 2.0.0
8 Upgrade notes for 2.0.1
9 Upgrade notes for 2.0.2
10 Upgrade notes for 2.0.3
11 Upgrade notes for 2.0.4
12 Upgrade notes for 2.0.5
13 Upgrade notes for 2.0.6
14 Upgrade notes for 2.0.7
15 Upgrade notes for 2.0.8
16 Upgrade notes for 2.0.9
17 Upgrade notes for 2.0.10
18 Upgrade notes for 2.0.11
19 Upgrade notes for 2.0.12
20 Upgrade notes for 2.0.13
21 Upgrade notes for 2.0.14
22 Upgrade notes for 2.0.15
23 Upgrade notes for 2.0.16
24 Upgrade notes for 2.0.17
1 Login and configuring user
2 New host
3 New item
4 New trigger
5 Receiving problem notification
6 New template
5. Zabbix appliance
1 Configuring a host
2 Inventory
3 Mass update
1 Item key
Windows-specific item keys
1 Dynamic indexes
2 Special OIDs
3 SNMP traps
4 IPMI checks
5 Simple checks
6 Log file monitoring
7 Calculated items
8 Internal checks
9 SSH checks
10 Telnet checks
11 External checks
12 Aggregate checks
13 Trapper items
14 JMX monitoring
15 ODBC monitoring
3 History and trends
1 Extending Zabbix agents
5 Windows performance counters
6 Mass update
7 Value mapping
8 Applications
9 Queue
1 Configuring a trigger
2 Trigger expression
3 Trigger dependencies
4 Trigger severity
5 Customising trigger severities
6 Unit symbols
7 Mass update
1 Event sources
1 Simple graphs
2 Custom graphs
1 Configuring a network map
2 Link indicators
3 Screens
4 Slide shows
1 Configuring a template
2 Linking/unlinking
3 Nesting
1 E-mail
2 SMS
3 Jabber
4 Ez Texting
5 Custom alertscripts
1 Sending message
2 Remote commands
3 Additional operations
4 Using macros in messages
2 Conditions
3 Escalations
1 User macros
1 Configuring a user
2 Permissions
3 User groups
7. IT services
1 Web monitoring items
2 Real life scenario
9. Maintenance
10. Regular expressions
11. Event acknowledgment
Groups
Hosts
Configuring a network discovery rule
2 Active agent auto-registration
3 Low-level discovery
1 Proxies
2 Nodes
1 Dashboard
2 Overview
3 Web
4 Latest data
5 Triggers
6 Events
7 Graphs
8 Screens
9 Maps
10 Discovery
11 IT services
1 Overview
2 Hosts
1 Status of Zabbix
2 Availability report
3 Triggers top 100
4 Bar reports
1 Host groups
2 Templates
1 Applications
2 Items
3 Triggers
4 Graphs
5 Discovery rules
4 Maintenance
5 Web
6 Actions
7 Screens
8 Slide shows
9 Maps
10 Discovery
11 IT services
1 General
2 DM
3 Authentication
4 Users
5 Media types
6 Scripts
7 Audit
8 Queue
9 Notifications
10 Installation
1 Global notifications
2 Sound in browsers
3 Global search
4 Frontend maintenance mode
5 Definitions
6 Creating your own theme
7 Debug mode
> Action object
action.create
action.delete
action.exists
action.get
action.update
> Alert object
alert.get
apiinfo.version
> Application object
application.create
application.delete
application.exists
application.get
application.massadd
application.update
configuration.export
configuration.import
> Discovered host object
dhost.exists
dhost.get
> Discovered service object
dservice.exists
dservice.get
> Discovery check object
dcheck.get
> Discovery rule object
drule.create
drule.delete
drule.exists
drule.get
drule.isreadable
drule.iswritable
drule.update
> Event object
event.acknowledge
event.get
> Graph object
graph.create
graph.delete
graph.exists
graph.get
graph.getobjects
graph.update
> Graph item object
graphitem.get
> Graph prototype object
graphprototype.create
graphprototype.delete
graphprototype.exists
graphprototype.get
graphprototype.getobjects
graphprototype.update
> History object
history.get
> Host object
host.create
host.delete
host.exists
host.get
host.getobjects
host.isreadable
host.iswritable
host.massadd
host.massremove
host.massupdate
host.update
> Host group object
hostgroup.create
hostgroup.delete
hostgroup.exists
hostgroup.get
hostgroup.getobjects
hostgroup.isreadable
hostgroup.iswritable
hostgroup.massadd
hostgroup.massremove
hostgroup.massupdate
hostgroup.update
> Host interface object
hostinterface.create
hostinterface.delete
hostinterface.exists
hostinterface.get
hostinterface.massadd
hostinterface.massremove
hostinterface.replacehostinterfaces
hostinterface.update
> Icon map object
iconmap.create
iconmap.delete
iconmap.get
iconmap.isreadable
iconmap.iswritable
iconmap.update
> Image object
image.create
image.delete
image.exists
image.get
image.getobjects
image.update
> Item object
item.create
item.delete
item.exists
item.get
item.getobjects
item.isreadable
item.iswritable
item.update
> Item prototype object
itemprototype.create
itemprototype.delete
itemprototype.exists
itemprototype.get
itemprototype.isreadable
itemprototype.iswritable
itemprototype.update
> IT Service object
service.adddependencies
service.addtimes
service.create
service.delete
service.deletedependencies
service.deletetimes
service.get
service.getsla
service.isreadable
service.iswritable
service.update
> LLD rule object
discoveryrule.copy
discoveryrule.create
discoveryrule.delete
discoveryrule.exists
discoveryrule.get
discoveryrule.isreadable
discoveryrule.iswritable
discoveryrule.update
> Maintenance object
maintenance.create
maintenance.delete
maintenance.exists
maintenance.get
maintenance.update
> Map object
map.create
map.delete
map.exists
map.get
map.getobjects
map.isreadable
map.iswritable
map.update
> Media object
usermedia.get
> Media type object
mediatype.create
mediatype.delete
mediatype.get
mediatype.update
> Proxy object
proxy.create
proxy.delete
proxy.get
proxy.isreadable
proxy.iswritable
proxy.update
> Screen object
screen.create
screen.delete
screen.exists
screen.get
screen.update
> Screen item object
screenitem.create
screenitem.delete
screenitem.get
screenitem.isreadable
screenitem.iswritable
screenitem.update
screenitem.updatebyposition
> Script object
script.create
script.delete
script.execute
script.get
script.getscriptsbyhosts
script.update
> Template object
template.create
template.delete
template.exists
template.get
template.getobjects
template.isreadable
template.iswritable
template.massadd
template.massremove
template.massupdate
template.update
> Template screen object
templatescreen.copy
templatescreen.create
templatescreen.delete
templatescreen.exists
templatescreen.get
templatescreen.isreadable
templatescreen.iswritable
templatescreen.update
> Template screen item object
templatescreenitem.get
> Trigger object
trigger.adddependencies
trigger.create
trigger.delete
trigger.deletedependencies
trigger.exists
trigger.get
trigger.getobjects
trigger.isreadable
trigger.iswritable
trigger.update
> Trigger prototype object
triggerprototype.create
triggerprototype.delete
triggerprototype.get
triggerprototype.update
> User object
user.addmedia
user.authenticate
user.create
user.delete
user.deletemedia
user.get
user.isreadable
user.iswritable
user.login
user.logout
user.update
user.updatemedia
user.updateprofile
> User group object
usergroup.create
usergroup.delete
usergroup.exists
usergroup.get
usergroup.getobjects
usergroup.isreadable
usergroup.iswritable
usergroup.massadd
usergroup.massupdate
usergroup.update
> User macro object
usermacro.create
usermacro.createglobal
usermacro.delete
usermacro.deleteglobal
usermacro.get
usermacro.update
usermacro.updateglobal
> Web scenario object
webcheck.create
webcheck.delete
webcheck.get
webcheck.isreadable
webcheck.iswritable
webcheck.update
Generic Zabbix API information
Zabbix API changes from 1.8 to 2.0
Zabbix API changes in 2.0
1 Frequently asked questions / Troubleshooting
1 Database creation scripts
2 Zabbix agent on Microsoft Windows
3 Troubleshooting installation issues
1 Zabbix server
2 Zabbix proxy
3 Zabbix agent (UNIX)
4 Zabbix agent (Windows)
5 Zabbix Java gateway
6 Archive: Zabbix agent (UNIX, Inetd version)
7 Special notes on "Include" parameter
1 Items supported by platform
2 vm.memory.size parameters
3 Passive and active agent checks
4 Encoding of returned values
5 Large file support
6 Unreachable/unavailable host settings
7 Implementation details of net.tcp.service checks
1 Supported trigger functions
1 Macros supported by location
7 Setting time periods
8 Command execution
9 Recipes for monitoring
10 Performance tuning
11 Version compatibility
zabbix_agentd
zabbix_get
zabbix_proxy
zabbix_sender
zabbix_server
Zabbix API
Table of Contents

Zabbix API

Zabbix API provides programmable interface to Zabbix for mass manipulations, 3rd party software integration and other purposes.

Currently Zabbix API specification is in draft state. All objects marked as 'draft' are experimental and should be used with a great care. We do not guarantee compatibility with future releases.

Object specifications without the 'draft' mark are stable and can be used for production purposes.

See Zabbix wiki for community provided solutions around the API.

See full list of API methods in the Appendixes section.

© 2001-2024 by Zabbix SIA. All rights reserved.
Except where otherwise noted, Zabbix Documentation is licensed under the following license
Trademark Policy