From 3bc90e83e5964518b11dfa40567deb82102dd69d Mon Sep 17 00:00:00 2001 From: Noah Hilverling Date: Thu, 29 Jul 2021 17:56:35 +0200 Subject: [PATCH] Docs: Describe parameter 'expiry' in 'add-comment' API action --- doc/12-icinga2-api.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/doc/12-icinga2-api.md b/doc/12-icinga2-api.md index 12666c90d56..591c2d4dc2f 100644 --- a/doc/12-icinga2-api.md +++ b/doc/12-icinga2-api.md @@ -1276,10 +1276,11 @@ Adds a `comment` from an `author` to services or hosts. Send a `POST` request to the URL endpoint `/v1/actions/add-comment`. - Parameter | Type | Description - ----------|--------|-------------- - author | string | **Required.** Name of the author, may be empty. - comment | string | **Required.** Comment text, may be empty. + Parameter | Type | Description + ----------|-----------|-------------- + author | string | **Required.** Name of the author, may be empty. + comment | string | **Required.** Comment text, may be empty. + expiry | Timestamp | **Optional.** Comment expiry time. In addition to these parameters a [filter](12-icinga2-api.md#icinga2-api-filters) must be provided. The valid types for this action are `Host` and `Service`.