zapi-lib

Minimal Zabbix JSON-RPC API client for Python — a thin, httpx-only wrapper around the single /api_jsonrpc.php endpoint.

Spun out of zapi-mcp so that tools which only need the API client — e.g. speedtest-z — can depend on it without pulling in the MCP server stack (mcp, starlette, uvicorn, …).

Features

Version-adaptive auth: user + auth field (Zabbix ≤ 6.2) and username + Authorization: Bearer (6.4 / 7.0), degrading to the proven path automatically.
Read helpers: get_hosts, get_items, get_problems, count_problems, get_events.
Write helpers: set_host_tag (idempotent host-tag upsert that preserves other tags), acknowledge_problem.
Provisioning (ZapiProvisioner): config-driven client that auto-creates trapper hosts/items stamped with a managed-by tag — create_host, update_host, create_item, update_item, set_maintenance, plus ensure_group / get_host_ids / get_item_ids.
Escape hatch: call(method, params) invokes any JSON-RPC method directly.
A single runtime dependency: httpx.

Install

pip install zapi-lib

Usage

from zapi_lib import ZapiClient, tag_filter

with ZapiClient("https://zabbix.example.com", "api-user", "api-pass") as z:
    hosts = z.get_hosts(tags=[tag_filter("speedtest-z")])
    z.set_host_tag("eduroam", "speedtest-z", "0.10.0")

The URL may be given with or without the /api_jsonrpc.php suffix.

Provisioning (config-driven)

ZapiProvisioner extends ZapiClient for metric-collection scripts that register the targets they push values to. It reads connection and provisioning defaults from a config.ini [zabbix] section and auto-creates trapper hosts/items tagged with a managed-by marker:

[zabbix]
url      = https://zabbix.example.com/api_jsonrpc.php
id       = api-user        ; or `user`
pw       = api-pass        ; or `password`
group    = DefaultGroup    ; default host group for created/updated hosts
location = tokyo           ; optional; added as a `location` tag
tag      = my-collector    ; optional; managed-by marker tag on hosts/items

from zapi_lib import ZapiProvisioner

with ZapiProvisioner.from_config() as z:  # ./config.ini, then ~/.config.ini
    z.show_version()
    host_ids = z.get_host_ids("pool-a") or z.create_host("pool-a", location="tokyo")
    host_id = host_ids[0]
    if not z.get_item_ids(host_id, "usage"):
        z.create_item(host_id, "usage", value_type=0)

update_host replaces the host's groups and tags (use set_host_tag to upsert a single tag instead). set_maintenance(location, since, till, name, description) opens an idempotent maintenance window over hosts carrying a matching location tag.

License

MIT

Development Status
- 3 - Alpha
Intended Audience
- System Administrators
Operating System
- OS Independent
Programming Language
Topic
- System :: Monitoring

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zapi_lib-0.4.0.tar.gz (17.2 kB view details)

Uploaded Aug 8, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

zapi_lib-0.4.0-py3-none-any.whl (11.3 kB view details)

Uploaded Aug 8, 2026 Python 3

File details

Details for the file zapi_lib-0.4.0.tar.gz.

File metadata

Download URL: zapi_lib-0.4.0.tar.gz
Upload date: Aug 8, 2026
Size: 17.2 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for zapi_lib-0.4.0.tar.gz
Algorithm	Hash digest
SHA256	`5e5dd0fc6e9f331a64286ce9168bbf445b3333c9d0aaab2edd66dce16aca39b3`
MD5	`7ee67358fdeb1ca70672610d1c749c17`
BLAKE2b-256	`960b535bdb9b64eab41d136d36b1115aede31e2244e6696fe55d889a153e7a7c`

See more details on using hashes here.

Provenance

The following attestation bundles were made for zapi_lib-0.4.0.tar.gz:

Publisher: release.yml on shigechika/zapi-lib

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: zapi_lib-0.4.0.tar.gz
- Subject digest: 5e5dd0fc6e9f331a64286ce9168bbf445b3333c9d0aaab2edd66dce16aca39b3
- Sigstore transparency entry: 2384132727
- Sigstore integration time: Aug 8, 2026
Source repository:
- Permalink: shigechika/zapi-lib@fda0b1493556baf39b47a061c952918cefb837a7
- Branch / Tag: refs/tags/v0.4.0
- Owner: https://github.com/shigechika
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@fda0b1493556baf39b47a061c952918cefb837a7
- Trigger Event: release