Disable a rule

Server: https://{kibana_url}

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

Api key auth Basic auth

Path Parameters

id string required: The identifier for the rule.

Request

untrack boolean: Defines whether this rule's alerts should be untracked.

Responses

204

Indicates a successful call.

400

Indicates an invalid schema.

403

Indicates that this call is forbidden.

404

Indicates a rule with the given ID does not exist.

Examples

A request that disables a rule and untracks all alerts that were generated by the rule.

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST /api/alerting/rule/{id}/_disable
{
  "untrack": true
}

curl Shell

curl -X POST "https://{kibana_url}/api/alerting/rule/{id}/_disable" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
  "untrack": true
}'

Response

No body