IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Disable rule API
editDisable rule API
editDisable a rule.
For the most up-to-date API details, refer to the open API specification.
Request
editPOST <kibana host>:<port>/api/alerting/rule/<id>/_disable
POST <kibana host>:<port>/s/<space_id>/api/alerting/rule/<id>/_disable
Prerequisites
editYou must have all
privileges for the appropriate Kibana features, depending on
the consumer
and rule_type_id
of the rule. For example,
the Management > Stack Rules feature, Analytics > Discover and Machine Learning
features, Observability, and Security features. For more details, refer to
Feature privileges.
Path parameters
edit-
id
- (Required, string) The ID of the rule that you want to disable.
-
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-
204
- Indicates a successful call.
Examples
editPOST api/alerting/rule/41893910-6bca-11eb-9e0d-85d233e3ee35/_disable