]> granicus.if.org Git - icinga2/commitdiff
Fix incorrect parameter name in the API documentation
authorGunnar Beutner <gunnar.beutner@icinga.com>
Mon, 5 Mar 2018 07:43:13 +0000 (08:43 +0100)
committerMichael Friedrich <michael.friedrich@icinga.com>
Thu, 19 Apr 2018 08:49:01 +0000 (10:49 +0200)
fixes #6140

refs #6145

doc/12-icinga2-api.md

index 1b6747ea159a5097cb41742552a12dc7507b5a5a..0588b8646ac27f539d86d8c5c3d73640fec482e6 100644 (file)
@@ -867,16 +867,16 @@ Send a `POST` request to the URL endpoint `/v1/actions/reschedule-check`.
   Parameter    | Type      | Description
   -------------|-----------|--------------
   next\_check  | Timestamp | **Optional.** The next check will be run at this time. If omitted, the current time is used.
-  force\_check | Boolean   | **Optional.** Defaults to `false`. If enabled, the checks are executed regardless of time period restrictions and checks being disabled per object or on a global basis.
+  force        | Boolean   | **Optional.** Defaults to `false`. If enabled, the checks are executed regardless of time period restrictions and checks being disabled per object or on a global basis.
 
 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`.
 
 The example reschedules all services with the name "ping6" to immediately perform a check
 (`next_check` default), ignoring any time periods or whether active checks are
-allowed for the service (`force_check=true`).
+allowed for the service (`force=true`).
 
     $ curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/actions/reschedule-check' \
-    -d '{ "type": "Service", "filter": "service.name==\"ping6\"", "force_check": true }' | python -m json.tool
+    -d '{ "type": "Service", "filter": "service.name==\"ping6\"", "force": true }' | python -m json.tool
 
     {
         "results": [