Disable a rule

POST /api/alerting/rule/{ruleId}/_disable

You 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.

Headers

  • kbn-xsrf string Required

    Cross-site request forgery protection

Path parameters

  • ruleId string Required

    An identifier for the rule.

Responses

  • 204

    Indicates a successful call.

  • 401 application/json; Elastic-Api-Version=2023-10-31

    Authorization information is missing or invalid.

    Hide response attributes Show response attributes object
  • 404 application/json; Elastic-Api-Version=2023-10-31

    Object is not found.

    Hide response attributes Show response attributes object
POST /api/alerting/rule/{ruleId}/_disable 
curl \
 -X POST https://localhost:5601/api/alerting/rule/ac4e6b90-6be7-11eb-ba0d-9b1c1f912d74/_disable \
 -H "kbn-xsrf: string"
Response examples (401) 
{
  "error": "Unauthorized",
  "message": "string",
  "statusCode": 401
}
Response examples (404) 
{
  "error": "Not Found",
  "message": "Saved object [alert/caaad6d0-920c-11ed-b36a-874bd1548a00] not found",
  "statusCode": 404
}