manual:api:reference:host:get

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Next revision Both sides next revision
manual:api:reference:host:get [2020/05/05 11:31]
martins-v frontends/php -> ui (ZBX-17667)
manual:api:reference:host:get [2020/11/06 12:07]
robertsl
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 60: 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. | |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. |
Line 280: 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"​
                 }                 }