]> granicus.if.org Git - icinga2/commitdiff
Document the 'ignore_on_error' attribute for object creation
authorMichael Friedrich <michael.friedrich@icinga.com>
Tue, 6 Feb 2018 17:03:36 +0000 (18:03 +0100)
committerMichael Friedrich <michael.friedrich@icinga.com>
Thu, 19 Apr 2018 08:51:05 +0000 (10:51 +0200)
fixes #5797

refs #6080

doc/12-icinga2-api.md

index 0588b8646ac27f539d86d8c5c3d73640fec482e6..9c3f2bd0e63b103b0f01c607cebeea22eeb849b2 100644 (file)
@@ -603,10 +603,11 @@ method:
 New objects must be created by sending a PUT request. The following
 parameters need to be passed inside the JSON body:
 
-  Parameters | Type         | Description
-  -----------|--------------|--------------------------
-  templates  | Array        | **Optional.** Import existing configuration templates for this object type. Note: These templates must either be statically configured or provided in [config packages](12-icinga2-api.md#icinga2-api-config-management)-
-  attrs      | Dictionary   | **Required.** Set specific object attributes for this [object type](09-object-types.md#object-types).
+  Parameters        | Type         | Description
+  ------------------|--------------|--------------------------
+  templates         | Array        | **Optional.** Import existing configuration templates for this object type. Note: These templates must either be statically configured or provided in [config packages](12-icinga2-api.md#icinga2-api-config-management)-
+  attrs             | Dictionary   | **Required.** Set specific object attributes for this [object type](09-object-types.md#object-types).
+  ignore\_on\_error | Boolean      | **Optional.** Ignore object creation errors and return an HTTP 200 status instead.
 
 The object name must be specified as part of the URL path. For objects with composite names (e.g. services)
 the full name (e.g. `example.localdomain!http`) must be specified.