kibana/docs/api/alerts/enable.asciidoc
Yuliia Naumenko 8552bec23c
[Alerting][Docs] Fixed Kibana API does not consistently refer to Kibana Spaces Requests for Alarms and Connectors. (#92948)
* [Alerting][Docs] Fixed Kibana API does not consistently refer to Kibana Spaces Requests for Alarms and Connectors.

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
2021-03-01 12:05:19 -08:00

39 lines
888 B
Text

[[alerts-api-enable]]
=== Enable alert API
++++
<titleabbrev>Enable alert</titleabbrev>
++++
Enable an alert.
[[alerts-api-enable-request]]
==== Request
`POST <kibana host>:<port>/api/alerts/alert/<id>/_enable`
`POST <kibana host>:<port>/s/<space_id>/api/alerts/alert/<id>/_enable`
[[alerts-api-enable-path-params]]
==== Path parameters
`id`::
(Required, string) The ID of the alert that you want to enable.
`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
[[alerts-api-enable-response-codes]]
==== Response code
`200`::
Indicates a successful call.
==== Example
Enable an alert with ID:
[source,sh]
--------------------------------------------------
$ curl -X POST api/alerts/alert/41893910-6bca-11eb-9e0d-85d233e3ee35/_enable
--------------------------------------------------
// KIBANA