IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Delete rule API Enable rule API »
Elastic Docs ›Kibana Guide [8.5] ›REST API ›Alerting APIs

Disable rule API

edit

Disable rule API

edit

Disable a rule.

Request

edit

POST <kibana host>:<port>/api/alerting/rule/<id>/_disable

POST <kibana host>:<port>/s/<space_id>/api/alerting/rule/<id>/_disable

Prerequisites

edit

You must have all privileges for the appropriate Kibana features, depending on the consumer and rule_type_id of the rules you’re disabling. 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
200
Indicates a successful call.

Examples

edit
POST api/alerting/rule/41893910-6bca-11eb-9e0d-85d233e3ee35/_disable
« Delete rule API Enable rule API »