]> granicus.if.org Git - icinga2/commitdiff
Document check_command may be a string 7057/head 7059/head
authorJean Flach <jean-marcel.flach@icinga.com>
Thu, 28 Mar 2019 12:33:52 +0000 (13:33 +0100)
committerJean Flach <jean-marcel.flach@icinga.com>
Thu, 28 Mar 2019 12:33:52 +0000 (13:33 +0100)
doc/12-icinga2-api.md

index 2375ce8b23f20c105fbe44545eff9280f785261f..bfeca45fb6f0a196c313d4e23a647e0252d36303 100644 (file)
@@ -931,7 +931,7 @@ Send a `POST` request to the URL endpoint `/v1/actions/process-check-result`.
   exit\_status       | Number                         | **Required.** For services: 0=OK, 1=WARNING, 2=CRITICAL, 3=UNKNOWN, for hosts: 0=OK, 1=CRITICAL.
   plugin\_output     | String                         | **Required.** One or more lines of the plugin main output. Does **not** contain the performance data.
   performance\_data  | Array<code>&#124;</code>String | **Optional.** The performance data as array of strings. The raw performance data string can be used too.
-  check\_command     | Array                          | **Optional.** The first entry should be the check commands path, then one entry for each command line option followed by an entry for each of its argument.
+  check\_command     | Array<code>&#124;</code>String | **Optional.** The first entry should be the check commands path, then one entry for each command line option followed by an entry for each of its argument. Alternativly a single string can be used.
   check\_source      | String                         | **Optional.** Usually the name of the `command_endpoint`
   execution\_start   | Timestamp                      | **Optional.** The timestamp where a script/process started its execution.
   execution\_end     | Timestamp                      | **Optional.** The timestamp where a script/process ended its execution. This timestamp is used in features to determine e.g. the metric timestamp.