- Kibana Guide: other versions:
- What is Kibana?
- What’s new in 8.3
- 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
- Short URLs APIs
- Get Task Manager health
- Upgrade assistant APIs
- Kibana plugins
- Troubleshooting
- Accessibility
- Release notes
- Developer guide
Get alerting framework health API
editGet alerting framework health API
editRetrieve the health status of the alerting framework.
Request
editGET <kibana host>:<port>/api/alerting/_health
GET <kibana host>:<port>/s/<space_id>/api/alerting/_health
Prerequisites
editYou must have read
privileges for the Management > Stack Rules feature or
for at least one of the Analytics > Discover, Analytics > Machine Learning,
Observability, or Security features.
Path parameters
edit-
space_id
-
(Optional, string) An identifier for the space. If
space_id
is not provided in the URL, the default space is used.
Response codes
edit-
200
- Indicates a successful call.
Examples
editRetrieve the health status of the alerting framework:
GET api/alerting/_health
The API returns the following:
{ "is_sufficiently_secure":true, "has_permanent_encryption_key":true, "alerting_framework_health":{ "decryption_health":{ "status":"ok", "timestamp":"2022-06-21T21:46:15.023Z" }, "execution_health":{ "status":"ok", "timestamp":"2022-06-21T21:46:15.023Z" }, "read_health":{ "status":"ok", "timestamp":"2022-06-21T21:46:15.023Z" } }, "alerting_framework_heath":{ "_deprecated":"This state property has a typo, use \"alerting_framework_health\" instead.","decryption_health":{ "status":"ok", "timestamp":"2022-06-21T21:46:15.023Z" }, "execution_health":{ "status":"ok", "timestamp":"2022-06-21T21:46:15.023Z" }, "read_health":{ "status":"ok", "timestamp":"2022-06-21T21:46:15.023Z" } } }
|
|
|
|
|
|
|