]> granicus.if.org Git - icinga2/commitdiff
Docs: Add an example for API joins with comments and host/services
authorMichael Friedrich <michael.friedrich@netways.de>
Wed, 24 Feb 2016 20:31:10 +0000 (21:31 +0100)
committerMichael Friedrich <michael.friedrich@netways.de>
Fri, 11 Mar 2016 14:49:22 +0000 (15:49 +0100)
fixes #10976

doc/9-icinga2-api.md

index ee0e6f45ace2a7133b9d215667e3ea245027fd1c..42c9d3077c2d812e4a673337f89f5fd8ff1df249 100644 (file)
@@ -501,6 +501,11 @@ via a join:
         ]
     }
 
+In case you want to fetch all [comments](6-object-types.md#objecttype-comment)
+for hosts and services, you can use the following query URL (similar example
+for downtimes):
+
+   https://localhost:5665/v1/objects/comments?joins=host&joins=service
 
 ### <a id="icinga2-api-config-objects-create"></a> Creating Config Objects