Zabbix icon

Zabbix

Consume Zabbix API (v.0.4.1)

Actions10

Service → Get

AI-generated

Summary

Retrieves Zabbix services.

Inputs

  • authentication (required) — Select 'Credentials' or 'API Token' for Zabbix access.
  • jsonParameters — Add parameters as JSON. Shown when disabled in favor of UI parameters.
  • parametersJson — Parameters as JSON (flat object) or JSON string. Shown when jsonParameters is true.
  • parametersUi — The query parameters to send. Shown when jsonParameters is false.
  • countOutput — Return the number of records in the result instead of the actual data. Default: false.
  • editable — If set to true, return only objects that the user has write permissions to. Default: false.
  • excludeSearch — Return results that do not match the criteria given in the search parameter. Default: false.
  • filter — Return only those results that exactly match the given filter. Doesn't work for text fields.
  • search — Return results that match the given wildcard search (case-insensitive). Works only for string and text fields.
  • searchByAny — If set to true, return results that match any of the criteria given in the filter or search parameter instead of all of them. Default: false.
  • searchWildcardsEnabled — If set to true enables the use of '*' as a wildcard character in the search parameter. Default: false.
  • sortfield — Sort the result by the given properties.
  • sortorder — Order of sorting. If an array is passed, each value will be matched to the corresponding property given in the sortfield parameter.
  • startSearch — The search parameter will compare the beginning of fields, that is, perform a LIKE '%…%' search instead. Ignored if searchWildcardsEnabled is set to true. Default: false.
  • preservekeys — Use IDs as keys in the resulting array. Default: false.
  • limit — Limit the number of records returned. Default: 0 (no limit).
  • outputOptions — Object properties to be returned. Default: extend.
  • outputPropertyNames — Array of property names to return only specific properties. Shown when outputOptions is propertyNames.
  • selectChildren — Return a children property with the child services. Default: extend.
  • selectParents — Return a parents property with the parent services. Default: extend.
  • selectTags — Return a tags property with service tags. Default: extend.
  • selectProblemEvents — Return a problem_events property with an array of problem event objects. Default: extend.
  • selectProblemTags — Return a problem_tags property with problem tags. Default: extend.
  • selectStatusRules — Return a status_rules property with status rules. Default: extend.
  • selectStatusTimeline — Return a status_timeline property containing service state changes for given periods. Used with period_from and period_to.
  • withoutProblemTags — Return only services without problem tags. Default: false.
  • serviceids — Return only services with the given IDs.
  • parentids — Return only services created that are linked to the given parent services.
  • deep_parentids — Return all direct and indirect child services. Used together with Parent IDs.
  • childids — Return only services that are linked to the given child services.
  • evaltype — Rules for tag searching. Default: 0 (And/Or).
  • tags — Return only services with given tags. Exact match by tag and case-sensitive or case-insensitive search by tag value depending on operator value.

Output shape

Array of service objects from Zabbix service.get. The specific fields returned are determined by the select parameters (children, parents, tags, problem_events, status_rules, status_timeline) and outputOptions/outputPropertyNames. If countOutput is true, the result is a count integer instead of an array.

Authentication consumes credentials or API token. Side effect: API read operation against Zabbix instance.

Links

Discussion