Disable a rule

Base URL: https://{kibana_url}

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

Auth

Path parameters

id string required: The identifier for the rule.

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

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.

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

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

Console Kibana Dev Tools

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

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/alerting/rule/${ID}/_disable" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "untrack": true
  }'

Generated from the API spec

Response

No body

Path parameters

Header parameters

Request body { }

Responses

Request body