[icinga-checkins] icinga.org: icinga2/master: Docs: Add an example for API joins with comments and host/services

git at icinga.org git at icinga.org
Wed Feb 24 21:32:46 CET 2016


Module: icinga2
Branch: master
Commit: 3228586a623575a619c20917e9e7472a41c98429
URL:    https://git.icinga.org/?p=icinga2.git;a=commit;h=3228586a623575a619c20917e9e7472a41c98429

Author: Michael Friedrich <michael.friedrich at netways.de>
Date:   Wed Feb 24 21:31:10 2016 +0100

Docs: Add an example for API joins with comments and host/services

fixes #10976

---

 doc/9-icinga2-api.md |    5 +++++
 1 file changed, 5 insertions(+)

diff --git a/doc/9-icinga2-api.md b/doc/9-icinga2-api.md
index ee0e6f4..42c9d30 100644
--- a/doc/9-icinga2-api.md
+++ b/doc/9-icinga2-api.md
@@ -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
 



More information about the icinga-checkins mailing list