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>
48 lines
1.7 KiB
Plaintext
48 lines
1.7 KiB
Plaintext
[[alerting-apis]]
|
|
== Alerting APIs
|
|
|
|
The following APIs are available for {kib} alerting.
|
|
|
|
* <<create-rule-api, Create rule API>> to create a rule
|
|
|
|
* <<update-rule-api, Update rule API>> to update the attributes for existing rules
|
|
|
|
* <<get-rule-api, Get rule API>> to retrieve a single rule by ID
|
|
|
|
* <<delete-rule-api, Delete rule API>> to permanently remove a rule
|
|
|
|
* <<find-rules-api, Find rules API>> to retrieve a paginated set of rules by condition
|
|
|
|
* <<list-rule-types-api, List rule types API>> to retrieve a list of rule types
|
|
|
|
* <<enable-rule-api, Enable rule API>> to enable a single rule by ID
|
|
|
|
* <<disable-rule-api, Disable rule API>> to disable a single rule by ID
|
|
|
|
* <<mute-alert-api, Mute alert API>> to mute alert for a single rule by ID
|
|
|
|
* <<unmute-alert-api, Unmute alert API>> to unmute alert for a single rule by ID
|
|
|
|
* <<mute-all-alerts-api, Mute all alerts API>> to mute all alerts for a single rule by ID
|
|
|
|
* <<unmute-all-alerts-api, Unmute all alerts API>> to unmute all alerts for a single rule by ID
|
|
|
|
* <<get-alerting-framework-health-api, Get Alerting framework health API>> to retrieve the health of the Alerting framework
|
|
|
|
For deprecated APIs, refer to <<alerts-api>>.
|
|
|
|
include::alerting/create_rule.asciidoc[]
|
|
include::alerting/update_rule.asciidoc[]
|
|
include::alerting/get_rules.asciidoc[]
|
|
include::alerting/delete_rule.asciidoc[]
|
|
include::alerting/find_rules.asciidoc[]
|
|
include::alerting/list_rule_types.asciidoc[]
|
|
include::alerting/enable_rule.asciidoc[]
|
|
include::alerting/disable_rule.asciidoc[]
|
|
include::alerting/mute_all_alerts.asciidoc[]
|
|
include::alerting/mute_alert.asciidoc[]
|
|
include::alerting/unmute_all_alerts.asciidoc[]
|
|
include::alerting/unmute_alert.asciidoc[]
|
|
include::alerting/health.asciidoc[]
|
|
include::alerting/legacy/index.asciidoc[]
|