3abb79a179
* Move current alert HTTP APIs to legacy folder (#93943) * Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files * Create new rule HTTP APIs (#93980) * Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files * Move current alert HTTP APIs to legacy folder (#93943) * Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files * Add necessary files * Create rule route * Get rule API * Update rule API * Delete rule route * Aggregate rules API * Disable rule API * Enable rule API * Find rules API * Fix Update API * Get rule alert summary API * Get rule state API * Health API * Rule types API * Mute all API * Mute alert API * Unmute all API * Unmute alert route * Update API key API * corrected tpye by making it much more complicated * removed unneeded cocde * Fixes * Add back health route * mutedInstanceIds -> mutedAlertIds * lastRun -> last_run * alert_type_state -> rule_type_state & alert_instances -> alerts Co-authored-by: Gidi Meir Morris <github@gidi.io> * Create docs for new rule HTTP APIs, deprecate old docs (#94745) * Create docs for new APIs, deprecate old docs * Remove connector_type_id * Update docs * Add link to legacy APIs from rules API docs * Remove connector_type_id references * [DOCS] Add legacy APIs to index.asciidoc * Fix camel case Co-authored-by: lcawl <lcawley@elastic.co> * Make alerting tests use new rules APIs (#95159) * Make API integration tests use new HTTP APIs * Fix end to end tests * Fix test failures * Fix more test failures * Rename some files * Add tests for legacy APIs (#95333) * Initial commit (#95457) * Move some new alerting APIs to /internal (#95461) * Initial commit * Update README.md * Use internal API * Merge deprecated warning w/ alternative solution * Update API docs Co-authored-by: Gidi Meir Morris <github@gidi.io> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: lcawl <lcawley@elastic.co>
93 lines
2.4 KiB
Text
93 lines
2.4 KiB
Text
[[get-alerting-framework-health-api]]
|
|
=== Get Alerting framework health API
|
|
++++
|
|
<titleabbrev>Get Alerting framework health</titleabbrev>
|
|
++++
|
|
|
|
Retrieve the health status of the Alerting framework.
|
|
|
|
[[get-alerting-framework-health-api-request]]
|
|
==== Request
|
|
|
|
`GET <kibana host>:<port>/api/alerting/_health`
|
|
|
|
`GET <kibana host>:<port>/s/<space_id>/api/alerting/_health`
|
|
|
|
[[get-alerting-framework-health-api-params]]
|
|
==== Path parameters
|
|
|
|
`space_id`::
|
|
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
|
|
|
|
[[get-alerting-framework-health-api-codes]]
|
|
==== Response code
|
|
|
|
`200`::
|
|
Indicates a successful call.
|
|
|
|
[[get-alerting-framework-health-api-example]]
|
|
==== Example
|
|
|
|
Retrieve the health status of the Alerting framework:
|
|
|
|
[source,sh]
|
|
--------------------------------------------------
|
|
$ curl -X GET api/alerting/_health
|
|
--------------------------------------------------
|
|
// KIBANA
|
|
|
|
The API returns the following:
|
|
|
|
[source,sh]
|
|
--------------------------------------------------
|
|
{
|
|
"is_sufficiently_secure":true,
|
|
"has_permanent_encryption_key":true,
|
|
"alerting_framework_health":{
|
|
"decryption_health":{
|
|
"status":"ok",
|
|
"timestamp":"2021-02-10T23:35:04.949Z"
|
|
},
|
|
"execution_health":{
|
|
"status":"ok",
|
|
"timestamp":"2021-02-10T23:35:04.949Z"
|
|
},
|
|
"read_health":{
|
|
"status":"ok",
|
|
"timestamp":"2021-02-10T23:35:04.949Z"
|
|
}
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
|
|
The health API response contains the following properties:
|
|
|
|
[cols="2*<"]
|
|
|===
|
|
|
|
| `is_sufficiently_secure`
|
|
| Returns `false` if security is enabled, but TLS is not.
|
|
|
|
| `has_permanent_encryption_key`
|
|
| Return the state `false` if Encrypted Saved Object plugin has not a permanent encryption Key.
|
|
|
|
| `alerting_framework_health`
|
|
| This state property has three substates that identify the health of the alerting framework API: `decryption_health`, `execution_health`, and `read_health`.
|
|
|
|
|===
|
|
|
|
`alerting_framework_health` consists of the following properties:
|
|
|
|
[cols="2*<"]
|
|
|===
|
|
|
|
| `decryption_health`
|
|
| Returns the timestamp and status of the rule decryption: `ok`, `warn` or `error` .
|
|
|
|
| `execution_health`
|
|
| Returns the timestamp and status of the rule execution: `ok`, `warn` or `error`.
|
|
|
|
| `read_health`
|
|
| Returns the timestamp and status of the rule reading events: `ok`, `warn` or `error`.
|
|
|
|
|===
|