Update saved query APIedit
[preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Update saved queries.
You are unable to update a prebuilt saved query (prebuilt = true).
Requestedit
PUT <kibana host>:<port>/api/osquery/saved_queries/<id>
PUT <kibana host>:<port>/s/<space_id>/api/osquery/saved_queries/<id>
Path parametersedit
-
space_id -
(Optional, string) The space identifier. When
space_idis not provided in the URL, the default space is used. -
id - (Required, string) The ID of the saved query you want to update.
Request bodyedit
-
id - (Required, string) The saved query name.
-
description - (Optional, string) The saved query description.
-
platform - (Optional, string) Restricts the query to a specified platform. The default is all platforms. To specify multiple platforms, use commas. For example, linux,darwin.
-
query - (Required, string) The SQL query you want to run.
-
version - (Optional, string) Runs on Osquery versions greater than or equal to the specified version string.
-
interval - (Optional, integer) The interval, in seconds, to run the query.
-
ecs_mapping - (Optional, object) Maps Osquery result columns or static values to ECS fields.
Response codeedit
-
200 - Indicates a successful call.
Examplesedit
Update a name of the <my_saved query> saved query:
$ curl -X PUT api/osquery/saved_queries/<id> \
{
"id": "updated_my_saved_query_name",
}
The API returns the saved query saved object:
{
"data": {...}
}