- Kibana Guide: other versions:
- What is Kibana?
- What’s new in 8.4
- Kibana concepts
- Quick start
- Set up
- Install Kibana
- Configure Kibana
- Alerting and action settings
- APM settings
- Banners settings
- Enterprise Search settings
- Fleet settings
- i18n settings
- Logging settings
- Logs settings
- Metrics settings
- Monitoring settings
- Reporting settings
- Search sessions settings
- Secure settings
- Security settings
- Spaces settings
- Task Manager settings
- Telemetry settings
- URL drilldown settings
- Start and stop Kibana
- Access Kibana
- Securing access to Kibana
- Add data
- Upgrade Kibana
- Configure security
- Configure reporting
- Configure logging
- Configure monitoring
- Command line tools
- Production considerations
- Discover
- Dashboard and visualizations
- Canvas
- Maps
- Build a map to compare metrics by country or region
- Track, visualize, and alert on assets in real time
- Map custom regions with reverse geocoding
- Heat map layer
- Tile layer
- Vector layer
- Plot big data
- Search geographic data
- Configure map settings
- Connect to Elastic Maps Service
- Import geospatial data
- Troubleshoot
- Reporting and sharing
- Machine learning
- Graph
- Alerting
- Observability
- APM
- Security
- Dev Tools
- Fleet
- Osquery
- Stack Monitoring
- Stack Management
- REST API
- Get features API
- Kibana spaces APIs
- Kibana role management APIs
- User session management APIs
- Saved objects APIs
- Data views API
- Index patterns APIs
- Alerting APIs
- Action and connector APIs
- Cases APIs
- Import and export dashboard APIs
- Logstash configuration management APIs
- Machine learning APIs
- Osquery manager API
- Short URLs APIs
- Get Task Manager health
- Upgrade assistant APIs
- Kibana plugins
- Troubleshooting
- Accessibility
- Release notes
- Developer guide
Get saved-queries API
editGet saved-queries API
edit[preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Get saved queries.
Request
editGET <kibana host>:<port>/api/osquery/saved_queries
GET <kibana host>:<port>/s/<space_id>/api/osquery/saved_queries
Path parameters
edit-
space_id
-
(Optional, string) The space identifier. When
space_id
is not provided in the URL, the default space is used.
Query parameters
edit-
page
-
(Optional, integer) The page number to return. The default is
1
. -
perPage
-
(Optional, integer) The number of rules to return per page. The default is
20
. -
sortField
-
(Optional, string) Specifies the field that sorts the results. Options include
createdAt
orupdatedAt
. The default iscreatedAt
.Even though the JSON case object uses the
created_at
andupdated_at
fields, you must usecreatedAt
andupdatedAt
fields in the URL query. -
sortOrder
-
(Optional, string) Determines the sort order. Options include
desc
orasc
. The default isdesc
.
Response code
edit-
200
- Indicates a successful call.
Example
editRetrieve the first 10 saved queries:
$ curl -X GET api/osquery/saved-queries?page=1&perPage=10&sortField=updatedAt&sortOrder=asc
The API returns a JSON object of the retrieved saved queries:
{ "page": 1, "per_page": 100, "total": 11, "data": [ { "type": "osquery-saved-query", "id": "42ba9c50-0cc5-11ed-aa1d-2b27890bc90d", "namespaces": ["default"], "attributes": { "id": "saved_query_id", "description": "Saved query description", "query": "select * from uptime;", "platform": "linux,darwin", "version": "2.8.0", "interval": "60", "ecs_mapping": { "host.uptime": { "field": "total_seconds" } }, "created_by": "elastic", "created_at": "2022-07-26T09:28:08.597Z", "updated_by": "elastic", "updated_at": "2022-07-26T09:28:08.597Z", "prebuilt": false }, }, {...} ] }