upstream/icinga2
1
0
Fork 0
mirror of https://github.com/Icinga/icinga2.git synced 2026-05-28 04:12:13 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Docs: Add type parameter to schedule-downtime table

Browse source 
The type parameter was missing in the table. Removed the additonal text below the table.
This commit is contained in:
Bernd Arnold 2022-06-30 17:51:15 +02:00
parent 6f03cfd240
commit 20b446edfb
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -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: