Update a rule
Spaces method and path for this operation:
<div><span class="operation-verb put">put</span> <span class="operation-path">/s/{space_id}/api/alerting/rule/{id}</span></div>Refer to Spaces for more information.
Path parameters
The identifier for the rule.
Headers
A required header to protect against CSRF attacks
Request body
The name of the rule. While this name does not have to be unique, a distinctive name can help you identify a rule.
Indicates how frequently rule actions are triggered. Valid values include: onActionGroupChange: Actions run when the alert status changes; onActiveAlert: Actions run when the alert becomes active and at each check interval while the rule conditions are met; onThrottleInterval: Actions run when the alert becomes active and at the interval specified in the throttle property while the rule conditions are met. You cannot specify notify_when at both the rule and action level. The recommended approach is to set it for each action individually. If you set notify_when at the rule level and then edit the rule, it will automatically be converted to action-specific values.
The parameters for the rule.
Use the throttle property in the action frequency object instead. The throttle interval, which defines how frequently rule actions are triggered. You cannot specify the throttle interval at both the rule and action level. If you set the throttle interval at the rule level and then edit the rule, it will automatically be converted to action-specific values.
Response
Indicates a successful call.
Indicates whether the API key that is associated with the rule was created by the user.
The owner of the API key that is associated with the rule and used to run background tasks.
The name of the application or feature that owns the rule. For example: alerts, apm, discover, infrastructure, logs, metrics, ml, monitoring, securitySolution, siem, stackAlerts, or uptime.
The date and time that the rule was created.
The identifier for the user that created the rule.
Indicates whether you want the rule to run on an interval basis after it is created.
The identifier for the rule.
Indicates whether all alerts are muted.
The name of the rule.
Date and time of the next rule run.
Indicates how frequently rule actions are triggered. Valid values include: onActionGroupChange: Actions run when the alert status changes; onActiveAlert: Actions run when the alert becomes active and at each check interval while the rule conditions are met; onThrottleInterval: Actions run when the alert becomes active and at the interval specified in the throttle property while the rule conditions are met. You cannot specify notify_when at both the rule and action level. The recommended approach is to set it for each action individually. If you set notify_when at the rule level and then edit the rule, it will automatically be converted to action-specific values.
The parameters for the rule.
The rule revision number.
The rule type identifier.
Indicates whether the rule is running.
Identifier of the scheduled task.
Deprecated in 8.13.0. Use the throttle property in the action frequency object instead. The throttle interval, which defines how frequently rule actions are triggered. You cannot specify the throttle interval at both the rule and action level. If you set the throttle interval at the rule level and then edit the rule, it will automatically be converted to action-specific values.
The date and time of the latest updates to the rule.
The identifier for the user who was the last to update the rule.