diff --git a/docs/detections/api/lists/api-create-list-item.asciidoc b/docs/detections/api/lists/api-create-list-item.asciidoc index 83e1a1971e..71096fe420 100644 --- a/docs/detections/api/lists/api-create-list-item.asciidoc +++ b/docs/detections/api/lists/api-create-list-item.asciidoc @@ -28,7 +28,13 @@ when it is not provided. |`value` |String |The value used to evaluate exceptions. For information on how list item exceptions are evaluated, see <>. |Yes +|{ref}/docs-refresh.html[`refresh`] |String a| Determines when changes made by the request become visible to search. Defaults to `wait_for`. Valid values are: +* `true` +* `false` +* `wait_for` + +|No |============================================== ===== Example requests diff --git a/docs/detections/api/lists/api-delete-list-item.asciidoc b/docs/detections/api/lists/api-delete-list-item.asciidoc index f3d3bb2816..33f08b316a 100644 --- a/docs/detections/api/lists/api-delete-list-item.asciidoc +++ b/docs/detections/api/lists/api-delete-list-item.asciidoc @@ -9,6 +9,24 @@ Deletes list items. ===== URL query parameters +[width="100%",options="header"] +|============================================== +|Name |Type |Description |Required + +|`id` |String |Unique identifier of the list item. |Required if `list_id` and `value` are not specified. +|`list_id` |String |Unique identifier of the <>. +|Required if `id` is not specified. +|`value` |String |The value used to evaluate exceptions. For information on how +list item exceptions are evaluated, refer to +<>. |Required if `id` is not specified. +|{ref}/docs-refresh.html[`refresh`] |String a| Determines when changes made by the request are made visible to search. Defaults to `false`. Valid values are: + +* `true` +* `false` + +|Optional. +|============================================== + The URL query must include one of the following: * `id` - `DELETE /api/lists/items?id=` diff --git a/docs/detections/api/lists/api-import-list-items.asciidoc b/docs/detections/api/lists/api-import-list-items.asciidoc index f0aeaeb3c1..67b81cca90 100644 --- a/docs/detections/api/lists/api-import-list-items.asciidoc +++ b/docs/detections/api/lists/api-import-list-items.asciidoc @@ -36,6 +36,13 @@ curl -X POST ":/api/lists/items/_import" |Required when importing to an existing container. |`type` |String |The datatype of excludes the list container holds, which can be either `ip` or `keyword`. |Required when importing to a new container. +|{ref}/docs-refresh.html[`refresh`] |String a| Determines when changes made by the request become visible to search. Defaults to `wait_for`. Valid values are: + +* `true` +* `false` +* `wait_for` + +|Optional. |============================================== ===== Example requests diff --git a/docs/detections/api/lists/api-update-list-item.asciidoc b/docs/detections/api/lists/api-update-list-item.asciidoc index d5e8c1fde9..e27afd95a4 100644 --- a/docs/detections/api/lists/api-update-list-item.asciidoc +++ b/docs/detections/api/lists/api-update-list-item.asciidoc @@ -39,6 +39,12 @@ list item exceptions are evaluated, see |`_version` |String |Base-64 encoded value of `if_seq_no` and `if_primary_term` parameters, used to prevent update conflicts (see {ref}/optimistic-concurrency-control.html[Optimistic concurrency control]). |No +|{ref}/docs-refresh.html[`refresh`] |String a| Determines when changes made by the request become visible to search. Defaults to `false`. Valid values are: + +* `true` +* `false` + +|No |==============================================