manual:api:reference:host:get

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
manual:api:reference:host:get [2019/08/09 12:26]
talbergs removed "withInventory" flag from parameters
manual:api:reference:host:get [2021/01/27 20:27] (current)
Line 6: Line 6:
  
 The method allows to retrieve hosts according to the given parameters. The method allows to retrieve hosts according to the given parameters.
 +
 +<​note>​This method is available to users of any type. Permissions to call the method can be revoked in user role settings. See [[:​manual/​web_interface/​frontend_sections/​administration/​user_roles|User roles]] for more information.</​note>​
  
 ==== Parameters ==== ==== Parameters ====
Line 13: Line 15:
 The method supports the following parameters. The method supports the following parameters.
  
-^Parameter^Type^Description^+^Parameter^[[:​manual/​api/​reference_commentary#​data_types|Type]]^Description^
 |groupids|string/​array| Return only hosts that belong to the given groups. |  |groupids|string/​array| Return only hosts that belong to the given groups. | 
 |applicationids|string/​array| Return only hosts that have the given applications. | |applicationids|string/​array| Return only hosts that have the given applications. |
Line 31: Line 33:
 ^  ||| ^  |||
 |with_items|flag|Return only hosts that have items. \\ \\ Overrides the ''​with_monitored_items''​ and ''​with_simple_graph_items''​ parameters. | |with_items|flag|Return only hosts that have items. \\ \\ Overrides the ''​with_monitored_items''​ and ''​with_simple_graph_items''​ parameters. |
 +|with_item_prototypes|flag|Return only hosts that have item prototypes. \\ \\ Overrides the ''​with_simple_graph_item_prototypes''​ parameter. |
 +|with_simple_graph_item_prototypes|flag|Return only hosts that have item prototypes, which are enabled for creation and have numeric type of information. |
 |with_applications|flag|Return only hosts that have applications. | |with_applications|flag|Return only hosts that have applications. |
 |with_graphs|flag|Return only hosts that have graphs. | |with_graphs|flag|Return only hosts that have graphs. |
 +|with_graph_prototypes|flag|Return only hosts that have graph prototypes. |
 |with_httptests|flag|Return only hosts that have web checks. \\ \\ Overrides the ''​with_monitored_httptests''​ parameter. | |with_httptests|flag|Return only hosts that have web checks. \\ \\ Overrides the ''​with_monitored_httptests''​ parameter. |
 |with_monitored_httptests|flag|Return only hosts that have enabled web checks. | |with_monitored_httptests|flag|Return only hosts that have enabled web checks. |
Line 39: Line 44:
 |with_simple_graph_items|flag|Return only hosts that have items with numeric type of information. | |with_simple_graph_items|flag|Return only hosts that have items with numeric type of information. |
 |with_triggers|flag|Return only hosts that have triggers. \\ \\ Overrides the ''​with_monitored_triggers''​ parameter. | |with_triggers|flag|Return only hosts that have triggers. \\ \\ Overrides the ''​with_monitored_triggers''​ parameter. |
 +|withProblemsSuppressed|boolean|Return hosts that have suppressed problems. \\ \\ Possible values: \\ ''​null''​ - (default) all hosts; \\ ''​true''​ - only hosts with suppressed problems; \\ ''​false''​ - only hosts with unsuppressed problems. |
 |evaltype|integer|Rules for tag searching. \\ \\ Possible values: \\ 0 - (default) And/Or; \\ 2 - Or. | |evaltype|integer|Rules for tag searching. \\ \\ Possible values: \\ 0 - (default) And/Or; \\ 2 - Or. |
 +|severities|integer/​array|Return hosts that have only problems with given severities. Applies only if problem object is trigger. |
 |tags|array/​object|Return only hosts with given tags. Exact match by tag and case-sensitive or case-insensitive search by tag value depending on operator value. \\ Format: ''<​nowiki>​[{"​tag":​ "<​tag>",​ "​value":​ "<​value>",​ "​operator":​ "<​operator>"​},​ ...]</​nowiki>''​.\\ An empty array returns all hosts. \\ \\ Possible operator values: \\ 0 - (default) Contains; \\ 1 - Equals. | |tags|array/​object|Return only hosts with given tags. Exact match by tag and case-sensitive or case-insensitive search by tag value depending on operator value. \\ Format: ''<​nowiki>​[{"​tag":​ "<​tag>",​ "​value":​ "<​value>",​ "​operator":​ "<​operator>"​},​ ...]</​nowiki>''​.\\ An empty array returns all hosts. \\ \\ Possible operator values: \\ 0 - (default) Contains; \\ 1 - Equals. |
 +|inheritedTags|boolean|Return hosts that have given ''​tags''​ also in all of their linked templates. Default: \\ \\ Possible values: \\ ''​true''​ - linked templates must also have given ''​tags'';​ \\ ''​false''​ - (default) linked template tags are ignored. |
 ^  ||| ^  |||
 |selectApplications|query|Return an ''​[[:​manual/​api/​reference/​application/​object|applications]]''​ property with host applications.\\ \\ Supports ''​count''​. | |selectApplications|query|Return an ''​[[:​manual/​api/​reference/​application/​object|applications]]''​ property with host applications.\\ \\ Supports ''​count''​. |
Line 54: Line 62:
 |selectMacros|query|Return a ''​[[:​manual/​api/​reference/​usermacro/​object|macros]]''​ property with host macros. ​ | |selectMacros|query|Return a ''​[[:​manual/​api/​reference/​usermacro/​object|macros]]''​ property with host macros. ​ |
 |selectParentTemplates|query|Return a ''​[[:​manual/​api/​reference/​template/​object|parentTemplates]]''​ property with templates that the host is linked to.\\ \\ Supports ''​count''​. | |selectParentTemplates|query|Return a ''​[[:​manual/​api/​reference/​template/​object|parentTemplates]]''​ property with templates that the host is linked to.\\ \\ Supports ''​count''​. |
-|selectScreens|query|Return a ''​[[:​manual/​api/​reference/​screen/object|screens]]''​ property ​with host screens.\\ \\ Supports ''​count''​. |+|selectDashboards ​| query | Return a ''​[[:​manual/​api/​reference/​templatedashboard/object|dashboards]]''​ property. \\ \\ Supports ''​count''​. |
 |selectTags|query|Return a ''​[[:​manual/​api/​reference/​host/​object#​host_tag|tags]]''​ property with host tags. | |selectTags|query|Return a ''​[[:​manual/​api/​reference/​host/​object#​host_tag|tags]]''​ property with host tags. |
 +|selectInheritedTags|query| Return an ''​[[:​manual/​api/​reference/​host/​object#​host_tag|inheritedTags]]''​ property with tags that are on all templates which are linked to host. |
 |selectTriggers|query|Return a ''​[[:​manual/​api/​reference/​trigger/​object|triggers]]''​ property with host triggers.\\ \\ Supports ''​count''​. | |selectTriggers|query|Return a ''​[[:​manual/​api/​reference/​trigger/​object|triggers]]''​ property with host triggers.\\ \\ Supports ''​count''​. |
 ^  ||| ^  |||
 |filter ​ | object |Return only those results that exactly match the given filter.\\ \\ Accepts an array, where the keys are property names, and the values are either a single value or an array of values to match against. \\ \\ Allows filtering by interface properties. | |filter ​ | object |Return only those results that exactly match the given filter.\\ \\ Accepts an array, where the keys are property names, and the values are either a single value or an array of values to match against. \\ \\ Allows filtering by interface properties. |
-| limitSelects | integer | Limits the number of records returned by subselects. \\  \\ Applies to the following subselects: \\ ''​selectParentTemplates''​ - results will be sorted by ''​host'';​ \\ ''​selectInterfaces'';​ \\ ''​selectItems''​ - sorted by ''​name'';​ \\ ''​selectDiscoveries''​ - sorted by ''​name'';​ \\ ''​selectTriggers''​ - sorted by ''​description'';​ \\ ''​selectGraphs''​ - sorted by ''​name'';​ \\ ''​selectApplications''​ - sorted by ''​name'';​ \\ ''​selectScreens''​ - sorted by ''​name''​. |+| limitSelects | integer | Limits the number of records returned by subselects. \\  \\ Applies to the following subselects: \\ ''​selectParentTemplates''​ - results will be sorted by ''​host'';​ \\ ''​selectInterfaces'';​ \\ ''​selectItems''​ - sorted by ''​name'';​ \\ ''​selectDiscoveries''​ - sorted by ''​name'';​ \\ ''​selectTriggers''​ - sorted by ''​description'';​ \\ ''​selectGraphs''​ - sorted by ''​name'';​ \\ ''​selectApplications''​ - sorted by ''​name'';​ \\ ''​selectDashboards''​ - sorted by ''​name''​. |
 |search ​ | object |Return results that match the given wildcard search.\\ \\ Accepts an array, where the keys are property names, and the values are strings to search for. If no additional options are given, this will perform a ''​LIKE "​%…%"''​ search.\\ \\ Allows searching by interface properties. Works only with text fields. | |search ​ | object |Return results that match the given wildcard search.\\ \\ Accepts an array, where the keys are property names, and the values are strings to search for. If no additional options are given, this will perform a ''​LIKE "​%…%"''​ search.\\ \\ Allows searching by interface properties. Works only with text fields. |
 |searchInventory | object | Return only hosts that have inventory data matching the given wildcard search. \\ \\ This parameter is affected by the same additional parameters as ''​search''​. | |searchInventory | object | Return only hosts that have inventory data matching the given wildcard search. \\ \\ This parameter is affected by the same additional parameters as ''​search''​. |
Line 273: Line 282:
             "​parentTemplates":​ [             "​parentTemplates":​ [
                 {                 {
-                    "​name":​ "Template OS Linux",​+                    "​name":​ "​Linux",​
                     "​templateid":​ "​10001"​                     "​templateid":​ "​10001"​
                 },                 },
                 {                 {
-                    "​name":​ "Template App Zabbix Server",​+                    "​name":​ "​Zabbix Server",​
                     "​templateid":​ "​10047"​                     "​templateid":​ "​10047"​
                 }                 }
Line 379: Line 388:
                 }                 }
             ]             ]
 +        }
 +    ],
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +Retrieve hosts that have these tags not only on host level but also in their linked parent templates.
 +
 +Request:
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​method":​ "​host.get",​
 +    "​params":​ {
 +        "​output":​ ["​name"​],​
 +        "​tags":​ [{"​tag":​ "​A",​ "​value":​ "​1",​ "​operator":​ "​0"​}],​
 +        "​inheritedTags":​ true
 +    },
 +    "​auth":​ "​038e1d7b1735c6a5436ee9eae095879e",​
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +Response:
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​result":​ [
 +        {
 +            "​hostid":​ "​10623",​
 +            "​name":​ "PC room 1"
 +        },
 +        {
 +            "​hostid":​ "​10601",​
 +            "​name":​ "​Office"​
 +        }
 +    ],
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +=== Searching host with tags and template tags ===
 +
 +Retrieve a host with tags and all tags that are linked to parent templates.
 +
 +Request:
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​method":​ "​host.get",​
 +    "​params":​ {
 +        "​output":​ ["​name"​],​
 +        "​hostids":​ 10502,
 +        "​selectTags":​ ["​tag",​ "​value"​],​
 +        "​selectInheritedTags":​ ["​tag",​ "​value"​]
 +    },
 +    "​auth":​ "​038e1d7b1735c6a5436ee9eae095879e",​
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +Response:
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​result":​ [
 +        {
 +            "​hostid":​ "​10502",​
 +            "​name":​ "​Desktop",​
 +            "​tags":​ [
 +                {
 +                    "​tag":​ "​A",​
 +                    "​value":​ "​1"​
 +                }
 +            ],
 +            "​inheritedTags":​ [
 +                {
 +                    "​tag":​ "​B",​
 +                    "​value":​ "​2"​
 +                }
 +            ]
 +        }
 +    ],
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +=== Searching hosts by problem severity ===
 +
 +Retrieve hosts that have "​Disaster"​ problems.
 +
 +Request:
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​method":​ "​host.get",​
 +    "​params":​ {
 +        "​output":​ ["​name"​],​
 +        "​severities":​ 5
 +    },
 +    "​auth":​ "​038e1d7b1735c6a5436ee9eae095879e",​
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +Response:
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​result":​ [
 +        {
 +            "​hostid":​ "​10160",​
 +            "​name":​ "​Zabbix server"​
 +        }
 +    ],
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +Retrieve hosts that have "​Average"​ and "​High"​ problems.
 +
 +Request:
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​method":​ "​host.get",​
 +    "​params":​ {
 +        "​output":​ ["​name"​],​
 +        "​severities":​ [3, 4]
 +    },
 +    "​auth":​ "​038e1d7b1735c6a5436ee9eae095879e",​
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +Response:
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​result":​ [
 +        {
 +            "​hostid":​ "​20170",​
 +            "​name":​ "​Database"​
 +        },
 +        {
 +            "​hostid":​ "​20183",​
 +            "​name":​ "​workstation"​
         }         }
     ],     ],
Line 394: Line 550:
 ==== Source ==== ==== Source ====
  
-CHost::​get() in //frontends/​php/​include/​classes/​api/​services/​CHost.php//​.+CHost::​get() in //ui/​include/​classes/​api/​services/​CHost.php//​.