Skip to content

v1.41

Choose a tag to compare

@hermanekt hermanekt released this 19 Oct 23:42
· 8 commits to main since this release
ccff85d

v1.41 - 2026-10-20

The completeness release. The question behind it: does the server have a tool for every method the Zabbix API documents, on every release from 5.0 to 8.0, and nothing it does not? Checked by reading the method index of every object page of every release (265 documented methods, 10 releases) against the catalog, and the 8.0 reference pages property by property against the shipped get contracts. The answer was no on eleven methods, which this release adds, and yes on everything else: the version table was right, and the three places where the 8.0 documentation and the catalog disagree are documentation errors (the server itself refuses discovered and template status as sort fields).

Added

  • Business services (#97): service_get, service_create, service_update, service_delete. The one object with a full CRUD API on every release that had no tool. The get contract carries both shapes of the object: the trigger-based service of 5.0 to 5.4 (triggerid, goodsla, showsla, selectTimes, selectAlarms) and the tag-based tree of 6.0 and later (selectChildren, selectParents, selectProblemTags, selectStatusRules, deep_parentids, slaids), each dated. The write contract was measured on 6.0 to 8.0 like every other object: status, readonly, problem_events and the parent / child objects a get echoes are dropped before an update, created_at too (documented as writable, refused everywhere), uuid only on 6.2 where it is refused.
  • Zabbix 8.0 objects: apmtrace_get, apmspan_get, apmlog_get, apmmetric_get (the OpenTelemetry (OTel) traces, spans, log records and metric data points an 8.0 server ingests; time_from / time_till required, attribute conditions as [{"key", "value", "operator"}], paging with limit / offset), device_get and device_offboard (the mobile app installations paired with users), serverinfo_get (a server instance's last update time by its serverid, which settings_get returns on 8.0). All dated 8.0 in the version table, so a 7.4 server refuses them with the release they need, and tools/list marks them. Verified against 8.0.0rc2 (the full MCP round trip of v1.40 passes there too: 1206 of 1210 plain objects, the rest being Zabbix's own refusals); the APM tools answer with the server's own APM DB is not configured where no APM database is attached.
  • The undocumented API, found by reading the frontends. The reference pages are not the whole API: the service factory and the ACCESS_RULES of every API class were read out of the 6.0, 6.2, 6.4, 7.0, 7.2, 7.4 and 8.0.0rc2 frontends and compared with the pages. Three things came out of it. Complex event processing (ceprule.get / create / update / delete / resettimewindows, 8.0, no reference page in rc2): ceprule_get, ceprule_create, ceprule_update, ceprule_delete and ceprule_resettimewindows, with the shape taken from CCepRule.php (condition types, window types, the nineteen operation types, execute_when), the get contract from its OUTPUT_FIELDS, the write contract measured on rc2 (error and the eval_formula of the rule and operation filters are dropped) and the hand rule of LLD filters applied to its filters (formulaid only with a custom expression); verified live create / get / update / reset / delete. Host dashboards (hostdashboard.get, 7.0 and later, never documented): hostdashboard_get, the dashboards a host inherits from its templates with pages and widgets resolved for that host, hostids required. module.* answers on 6.0 and 6.2 although the reference lists it from 6.4; the version table says 6.0 now, so a 6.0 server is no longer refused. device.init and device.onboard (8.0) are the mobile app's own pairing calls and stay reachable through zabbix_raw_api_call only.
  • apiinfo_version: the API version of a server, the one method Zabbix refuses with credentials since 5.4. The server answers it from its own version probe, so nothing is sent with the token.
  • Relative time inputs: every timestamp parameter now also takes the frontend's relative syntax, evaluated in the zone resolved for the call: now, now-1h, now-7d, now/d (start of today), now-1d/d (yesterday), now/w (Monday 00:00), now-1M/M, now/y; units s m h d w M y. On a range end (time_till, period_to, active_till, lastChangeTill) the /unit rounding gives the last second of the unit, as the frontend's "To" field does, so time_from: now/d, time_till: now/d is the whole of today. Applies to typed parameters, extra_params, nested fields and zabbix_raw_api_call, like the ISO 8601 inputs of v1.37.4.
  • PDF reports in the caller's zone (the last item of #97): report_generate renders period boundaries, the "generated at" stamp and the backup matrix's day grouping in the zone resolved for the call ([server].timezone, the token's zone, the Zabbix user's zone, see Time zones in the README) and names it in the header, instead of UTC.
  • Write tools stay out of tools/list on a read-only server (#83, @ccurtis-kepler). A read-only token never saw the 169 write tools; a caller without one (stdio, the legacy auth_token, a read-write token) still got host_delete and the rest listed against a server that refuses every write, tried them and was refused. Now the per-caller tools/list (the same hook that carries the version notes since v1.38) leaves the write tools out when every server the caller can reach is read_only; one writable server among them keeps the full catalog. Clay Curtis's [server].register_write_tools = false from his fork branch is in as well, under his authorship: it leaves the write tools out of the registry unconditionally, which also keeps the catalog under a client's tool limit. Call-time checks are unchanged either way.
  • A token sees only its own servers (discussion #76, sebdew's MSP case, one [zabbix.*] per customer). The server parameter of every tool used to enumerate every configured instance in tools/list, whatever the token's allowed_servers, and Unknown Zabbix server 'x'. Available: ... listed them all too; where the instance name is the customer name, that is a leak. Now the per-caller tools/list rewrites the parameter's description to the servers the token may use (schemas are copied, never mutated), the unknown-server message names only those, and a token scoped to several servers that do not include the global default lands on the first of them when server is omitted (a single-server token has done so since v1.37; before, such a call hit the global default and was refused with somebody else's name). check_token_authorization still has the last word.
  • Zabbix 8.0 connects without skip_version_check: the zabbix-utils library (2.0.4) refuses a frontend newer than the 7.4 it was tested with. The server catches that refusal, connects anyway and logs a warning; a frontend below the library's minimum is refused as before (legacy_auth is the only way past that gate).

Changed

  • Version table audited against the method index of every release. METHOD_SINCE was already complete; METHOD_REMOVED now also dates the objects that left before 8.0 (template screens in 5.2; applications, screens and settings.getglobal in 5.4; the pre-6.0 service dependencies, times and service.getsla in 6.0; trigger.adddependencies / deletedependencies in 6.2; discoveryrule.copy in 7.2), each with the documented replacement, so a zabbix_raw_api_call to one of them on a newer server gets Use item tags (item.update with tags) instead rather than Zabbix's Method not found. user.checkAuthentication has a reference page only since 6.0 but exists on every release and is left undated.
  • The get contracts grew to 69 methods and 67 objects (service, apmlog, apmmetric, apmspan, apmtrace, device, serverinfo, ceprule, hostdashboard); the write contracts to 73 methods and 899 paths, now also measured on 8.0.0rc2 (23 000 API calls; the interface available quartet is still refused there, the fixtures gained the timeout_telemetry_query an 8.0 active proxy requires). The tool count is 241 in 68 API groups.
  • The admin portal's tool bubbles are rendered from TOOL_GROUPS instead of a copy of it in the template, which had missed problem_active_get, item_threshold_search and the other extension prefixes since v1.3x and would have missed every v1.41 prefix; the group descriptions name the new objects.
  • The admin portal's Tools section carries the three catalog switches as toggles: register_write_tools, strip_write_params (v1.40) and validate_get_params (v1.39), each marked as needing a restart; before, they were config-file only.
  • Every tool belongs to a tool group again: the v1.41 prefixes (service, apmtrace, apmspan, apmlog, apmmetric under monitoring; apiinfo, serverinfo, device under administration) are in TOOL_GROUPS, so a tools allowlist or a scoped token can reach them; a test now refuses a registered tool outside every group.
  • From Clay Curtis's fork, under his authorship: the AGPL header on the seven admin views that only had the copyright line, SECURITY.md saying what the two-step flow and the audit log do not cover, and the DNS-01 walkthrough in docs/OAUTH.md for hostnames that are not reachable on port 80.
  • README links the community zabbix-ops Claude skill by manumora (a triage runbook on top of these tools) under Related Projects.
  • device_get accepts only extend as output (the server refuses field lists); the tool says so and offers countOutput for a count.

Community

  • Every fork of this repository (56) was read branch by branch for this release. Taken, each as its author's own commit: from @ccurtis-kepler feat(server): register_write_tools option leaves write tools out of the catalog (34e993f, #83), chore: AGPL header on the seven admin views that only had the copyright line (d14dc39), docs(security): say what the two-step flow and the audit log do not cover (902d278) and docs(oauth): DNS-01 for hostnames that are not reachable on port 80 (ef80137). Linked: the zabbix-ops Claude skill by @manumora. Not taken, with the reason on record: Curtis's fix/source-file-symlink-check (it would refuse a symlink inside an allowed import directory, which #81 decided to accept; the escape is caught by containment and the TOCTOU swap by O_NOFOLLOW), alexpostnik's codex/issue39-action-filter-contract (local refusal of formulaid outside a custom expression, where v1.40 strips it by measurement and passes Zabbix's own message through), fsolen's DNS check (against a portal version that no longer has that block), fenbays's dynamic tool filtering (superseded by #83), and the deployment variants (Coolify, Alpine, UBI, GHCR) that belong to a packaging decision rather than to the server.

Tests

  • 787 tests (63 new): the undocumented objects (CEP rules through the tools with the filter rule, host dashboards dated 7.0), the per-token server scoping (schema, message, default), the read-only catalog filter and the registration switch, the portal toggles, the tool-group coverage, relative time parsing and rounding across a DST change, the from / till asymmetry through a tool, the new tools through the registered server (an 8.0 tool refused on 7.4 and passed on 8.0, apiinfo_version without an API call, a service round trip with the measured strip), the version-gate retry (newer release connects with a warning, older is still refused), the legacy removals in the version table, report time zones (_ts_to_str, day grouping, the engine's context and rendered header). Python 3.10 checked in python:3.10-slim.