Zabbix icon

Zabbix

Consume Zabbix API (v.0.4.1)

Actions10

Host → Get

AI-generated

Summary

Retrieve hosts from Zabbix server matching specified filter and select criteria.

Inputs

  • authentication — Authentication method for Zabbix API. Options: Credentials (default) or API Token.
  • jsonParameters — Add parameters as JSON. When true, enables parametersJson input.
  • parametersJson — Parameters as JSON (flat object) or JSON string. Shown when jsonParameters is true.
  • parametersUi — Query parameters sent to Zabbix host.get. Includes filter/select options such as groupids, applicationids, hostids, proxyids, templateids, monitored_hosts, proxy_hosts, severities, tags, and numerous with_* booleans controlling returned data scope.
  • selectApplicationsOptions — Return an applications property. Options: extend (default), count, propertyNames.
  • outputOptions — Object properties to be returned. Options: extend (default), count, propertyNames.
  • outputPropertyNames — Choose which properties to return. Shown when outputOptions is propertyNames.
  • limit — Limit the number of records returned. Default 0 (no limit).
  • countOutput — Return the number of records in the result instead of the actual data. Default false.
  • filter — Return only results that exactly match the given filter criteria. Does not work for text fields.
  • search — Return results matching the given wildcard search (case-insensitive). Works only for string and text fields. Default LIKE '%…%' search.
  • searchByAny — If true, return results matching any of the criteria given in filter or search instead of all.
  • searchWildcardsEnabled — If true, enables '*' as wildcard character in search parameter. Default false.
  • sortfield — Sort the result by given properties. Options include hostid, host, name, status.
  • sortorder — Order of sorting. Array matched to sortfield values. Options: ascending (ASC) or descending (DESC).
  • startSearch — If true, search compares beginning of fields (LIKE '…%'). Ignored if searchWildcardsEnabled is true. Default false.
  • preservekeys — Use IDs as keys in the resulting array. Default false.

Output shape

Array of host objects as returned by Zabbix host.get API method. Structure depends on select*Options, outputOptions, and filter/search parameters.

If countOutput is true, output is a single number representing record count. If limit is set, result array is truncated accordingly. preservekeys controls whether array keys are host IDs.

Links

Discussion