396 API Reference 5483112a

Zabbix API Reference

API Endpoint

All API calls go to: https://<zabbix-server>/api_jsonrpc.php

Authentication Methods

API Token (Zabbix 5.4+, Recommended)

api.login(token="your_api_token")

Username/Password

api.login(user="Admin", password="zabbix")
api.logout()  # Required when using user/password

Complete API Class Reference

Host Management

Key host.get parameters:

• output - Fields to return
• hostids - Filter by host IDs
• groupids - Filter by group IDs
• templateids - Filter by linked template IDs
• selectInterfaces - Include interface data
• selectGroups - Include group data
• selectParentTemplates - Include linked templates
• selectItems - Include items
• selectTriggers - Include triggers
• selectMacros - Include host macros
• filter - Exact match filters
• search - Pattern matching
• searchWildcardsEnabled - Enable wildcards in search

Host Groups

Templates

Items

Item types:

Value types:

Triggers

Trigger severities:

Events and Problems

Event sources:

• 0: Trigger
• 1: Discovery rule
• 2: Autoregistration
• 3: Internal

History

Important: The history parameter must match the item's value_type.

Maintenance

Timeperiod types:

• 0: One-time
• 2: Daily
• 3: Weekly
• 4: Monthly

Actions

Users

Configuration

Common Query Patterns

Filtering

# Exact match
api.host.get(filter={"host": "server01"})

# Multiple values
api.host.get(filter={"host": ["server01", "server02"]})

# Pattern search
api.host.get(search={"host": "server"}, searchWildcardsEnabled=True)

Pagination

# First page
api.host.get(limit=100)

# Next page
api.host.get(limit=100, offset=100)

Sorting

api.host.get(sortfield="host", sortorder="ASC")
api.trigger.get(sortfield=["priority", "lastchange"], sortorder=["DESC", "DESC"])

Output Control

# Specific fields only
api.host.get(output=["hostid", "host", "name"])

# All fields
api.host.get(output="extend")

# Count only
api.host.get(countOutput=True)

Error Codes

Rate Limiting

Zabbix API does not have built-in rate limiting, but consider:

• Use batch operations (arrays) when possible
• Limit output to needed fields
• Use countOutput when only count is needed
• Implement client-side rate limiting for bulk operations