- 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
IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Create saved query API
editCreate saved query 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. Create saved queries.
Request
editPOST <kibana host>:<port>/api/osquery/saved_queries
POST <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.
Request body
edit-
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) Uses the Osquery versions greater than or equal to the specified version string.
-
internal
- (Optional, string) An interval, in seconds, to run the query.
-
ecs_mapping
- (Optional, object) Maps Osquery results columns or static values to ECS fields.
Response code
edit-
200
- Indicates a successful call.
Examples
editCreate a saved query:
$ curl -X POST api/osquery/saved_queries \ { "id": "saved_query_id", "description": "Saved query description", "query": "select * from uptime;", "interval": "60", "version": "2.8.0", "platform": "linux,darwin", "ecs_mapping": { "host.uptime": { "field": "total_seconds" } } }
The API returns the saved query object:
{ "data": {...} }
Was this helpful?
Thank you for your feedback.