From 20b446edfbb553fd406a1b83af5cd1e0f5f78bad Mon Sep 17 00:00:00 2001 From: Bernd Arnold Date: Thu, 30 Jun 2022 17:51:15 +0200 Subject: [PATCH] Docs: Add type parameter to schedule-downtime table The type parameter was missing in the table. Removed the additonal text below the table. --- doc/12-icinga2-api.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/12-icinga2-api.md b/doc/12-icinga2-api.md index 5b7eacca3..380614a09 100644 --- a/doc/12-icinga2-api.md +++ b/doc/12-icinga2-api.md @@ -1376,6 +1376,7 @@ Send a `POST` request to the URL endpoint `/v1/actions/schedule-downtime`. Parameter | Type | Description --------------|-----------|-------------- + type | String | **Required.** Downtime type. Either `Host`, or `Service`. author | String | **Required.** Name of the author. comment | String | **Required.** Comment text. start\_time | Timestamp | **Required.** Timestamp marking the beginning of the downtime. @@ -1386,7 +1387,7 @@ Send a `POST` request to the URL endpoint `/v1/actions/schedule-downtime`. trigger\_name | String | **Optional.** Sets the trigger for a triggered downtime. See [downtimes](08-advanced-topics.md#downtimes) for more information on triggered downtimes. child\_options| String | **Optional.** Schedule child downtimes. `DowntimeNoChildren` does not do anything, `DowntimeTriggeredChildren` schedules child downtimes triggered by this downtime, `DowntimeNonTriggeredChildren` schedules non-triggered downtimes. Defaults to `DowntimeNoChildren`. -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. Example for scheduling a downtime for all `ping4` services: