PyZabbix Documentation

Install the pyzabbix package using pip to start working with the Zabbix API in Python.

$ pip install pyzabbix

PyZabbix uses the requests library. You can modify the underlying requests.Session object via zapi.session to configure headers, authentication, and SSL verification. You can also set a custom timeout directly on the zapi object.

from pyzabbix import ZabbixAPI

zapi = ZabbixAPI("http://zabbixserver.example.com")

# Enable HTTP auth
zapi.session.auth = ("http user", "http password")

# Disable SSL certificate verification
zapi.session.verify = False

# Specify a timeout (in seconds)
zapi.timeout = 5.1

# Login (if HTTP Auth is enabled, only the username is needed)
zapi.login("http user", "http password")

To use PyZabbix, import ZabbixAPI, instantiate it with your Zabbix server URL, and authenticate using either a username/password or an API token (for Zabbix >= 5.4).

from pyzabbix import ZabbixAPI

zapi = ZabbixAPI("http://zabbixserver.example.com")
zapi.login("zabbix user", "zabbix pass")
# For Zabbix >= 5.4, use an API token instead:
# zapi.login(api_token='xxxxx')

print("Connected to Zabbix API Version %s" % zapi.api_version())

for h in zapi.host.get(output="extend"):
    print(h['hostid'])

To debug API interactions, configure the pyzabbix logger to output to a stream (like sys.stdout) at the DEBUG level. This will show the JSON-RPC requests being sent and the responses received.

import sys
import logging
from pyzabbix import ZabbixAPI

stream = logging.StreamHandler(sys.stdout)
stream.setLevel(logging.DEBUG)
log = logging.getLogger('pyzabbix')
log.addHandler(stream)
log.setLevel(logging.DEBUG)

zapi = ZabbixAPI("http://zabbixserver.example.com")
zapi.login('admin','password')

If you are using Zabbix version 5.4 or newer, you can authenticate using an API token instead of a username and password by passing the api_token keyword argument to the login method.

zapi.login(api_token='xxxxx')