From: Michael Friedrich <michael.friedrich@netways.de>
Date: Wed, 24 Feb 2016 20:31:10 +0000 (+0100)
Subject: Docs: Add an example for API joins with comments and host/services
X-Git-Tag: v2.4.4~29
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=cd5f11b1ea9f7f1f5e345b07e1d266153afa914a;p=icinga2

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

fixes #10976
---

diff --git a/doc/9-icinga2-api.md b/doc/9-icinga2-api.md
index ee0e6f45a..42c9d3077 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