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 Overview of Zabbix
2 Goals and Principles
3 Installation and Upgrade Notes
4. What's new in Zabbix 1.8
5 What's new in Zabbix 1.8.1
6 What's new in Zabbix 1.8.2
7 What's new in Zabbix 1.8.3
8 What's new in Zabbix 1.8.4
9 What's new in Zabbix 1.8.5
10 What's new in Zabbix 1.8.6
11 What's new in Zabbix 1.8.7
11 What's new in Zabbix 1.8.8
11 What's new in Zabbix 1.8.9
12 What's new in Zabbix 1.8.10
13 What's new in Zabbix 1.8.11
14 What's new in Zabbix 1.8.12
15 What's new in Zabbix 1.8.13
15 What's new in Zabbix 1.8.14
16 What's new in Zabbix 1.8.15
17 What's new in Zabbix 1.8.16
18 What's new in Zabbix 1.8.17
19 What's new in Zabbix 1.8.18
20 What's new in Zabbix 1.8.20
21 What's new in Zabbix 1.8.21
22 What's new in Zabbix 1.8.22
1 How to Get Zabbix
2 Requirements
3 Components
4 Installation from Source
5 Upgrading
6 Using Zabbix appliance
1 Zabbix Server
2 Zabbix Proxy
3 Zabbix Agent (UNIX, Standalone daemon)
4 Zabbix Agent (UNIX, Inetd version)
5 Zabbix Agent (Windows)
6 Zabbix Sender (UNIX)
7 Zabbix Get (UNIX)
8 Special notes on "Include" configuration parameter
1 Actions
2 Macros
3 Applications
4 Graphs
5 Media
6 Host templates
7 Host groups
8 Host and trigger dependencies
10 User Parameters
11 Windows performance counters
12 Triggers
13 Screens and Slide Shows
14 IT Services
15 User permissions
16 The Queue
17 Utilities
18 Regular expressions
19 Items
20 Frontend definitions
21 Suffixes
22 Time period specification
1 Login
2 Add user
3 Email settings
4 Monitoring an agent-enabled host
5 Set up notifications
1 Goals
2 Overview
3 Host export
4 Host import
5 Map export and import
6 Screen export and import
1 Extending Zabbix Agents
2 Monitoring of log files
3 Remote commands
4 Monitoring of Windows Services
1 Goals
2 Overview
3 WEB Scenario
4 WEB Step
5 Real life scenario
1 Overview
2 How it works
1 Goals
2 Overview
3 How it works
4 Network discovery rule
5 Real life scenario
1 Special OIDs
2 Use of dynamic indexes
1 Goals
2 IPMI parameters
3 IPMI actions
1 Why use Proxy?
2 Proxy v.s. Node
3 Configuration
1 Goals
2 Overview
3 Configuration
4 Platform independence
5 Configuration of a single Node
6 Switching between nodes
7 Data flow
8 Performance considerations
1 Goals
2 Configuration
3 How it looks like
1 Creating your own theme
2 Configuration
3 Administration
4 Page parameters
1 Real world configuration
2 Performance tuning
1 General Recipes
2 Monitoring of Specific Applications
3 Integration
1 Error and warning messages
2 Sound in browsers
1 Overview
2 Simple messages
3 Remote commands
4 Repeated notifications
5 Delayed notifications
6 Escalate to Boss
7 Complex scenario
create()
delete()
exists()
get()
update()
get()
version()
create()
delete()
exists()
get()
massAdd()
update()
get()
delete()
get()
create()
delete()
exists()
get()
update()
create()
delete()
exists()
get()
update()
acknowledge()
delete()
get()
create()
delete()
exists()
get()
update()
get()
delete()
get()
create()
delete()
exists()
get()
massAdd()
massRemove()
massUpdate()
update()
create()
delete()
exists()
get()
massAdd()
massRemove()
massUpdate()
update()
create()
delete()
exists()
get()
update()
create()
delete()
exists()
get()
update()
create()
delete()
exists()
get()
update()
create()
delete()
exists()
get()
update()
create()
delete()
get()
update()
get()
create()
delete()
exists()
get()
update()
create()
delete()
execute()
get()
update()
create()
delete()
exists()
get()
massAdd()
massRemove()
massUpdate()
update()
addDependencies()
create()
delete()
deleteDependencies()
exists()
get()
update()
addMedia()
authenticate()
create()
delete()
deleteMedia()
get()
login()
logout()
update()
updateMedia()
updateProfile()
create()
delete()
exists()
get()
massAdd()
massRemove()
massUpdate()
update()
createGlobal()
deleteGlobal()
deleteHostMacro()
get()
massAdd()
massRemove()
massUpdate()
updateGlobal()
Example API session
Getting started with Zabbix API
zabbix_agentd
zabbix_get
zabbix_proxy
zabbix_sender
zabbix_server
1 Zabbix Agent
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.

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