tyler.durden
/
icinga2
mirror of https://github.com/Icinga/icinga2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #8943 from Icinga/bugfix/api-add-comment-expiry-docs 

Docs: Describe parameter 'expiry' in 'add-comment' API action
This commit is contained in:
Julian Brost 2021-07-30 09:03:42 +02:00 committed by GitHub
parent 40c186515b 3bc90e83e5
commit 4c90709fc6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/12-icinga2-api.md
View File

@ -1277,9 +1277,10 @@ Adds a `comment` from an `author` to services or hosts.
Send a `POST` request to the URL endpoint `/v1/actions/add-comment`. Send a `POST` request to the URL endpoint `/v1/actions/add-comment`.
Parameter | Type | Description Parameter | Type | Description
----------|--------|-------------- ----------|-----------|--------------
author | string | **Required.** Name of the author, may be empty. author | string | **Required.** Name of the author, may be empty.
comment | string | **Required.** Comment text, 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`. 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`.