Sign in

deb2e8b751e7

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-106771,7565.2 MB
alerting

Get rule details

Spaces method and path for this operation:

<div><span class="operation-verb get">get</span>&nbsp;<span class="operation-path">/s/{space_id}/api/alerting/rule/{id}</span></div>

Refer to Spaces for more information.

get/api/alerting/rule/{id}

Path parameters

idstring required

The identifier for the rule.

Response

Indicates a successful call.

api_key_created_by_userboolean nullable

Indicates whether the API key that is associated with the rule was created by the user.

api_key_ownerstring nullable

The owner of the API key that is associated with the rule and used to run background tasks.

consumerstring required

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.

created_atstring required

The date and time that the rule was created.

created_bystring nullable

The identifier for the user that created the rule.

enabledboolean required

Indicates whether you want the rule to run on an interval basis after it is created.

idstring required

The identifier for the rule.

mapped_paramsobject
mute_allboolean required

Indicates whether all alerts are muted.

muted_alert_idsstring[] required
namestring required

The name of the rule.

next_runstring nullable

Date and time of the next rule run.

notify_when'onActionGroupChange' | 'onActiveAlert' | 'onThrottleInterval' | 'null' nullable

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.

paramsobject required

The parameters for the rule.

revisionnumber required

The rule revision number.

rule_type_idstring required

The rule type identifier.

runningboolean nullable

Indicates whether the rule is running.

scheduled_task_idstring

Identifier of the scheduled task.

tagsstring[] required
throttlestring nullable

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.

updated_atstring required

The date and time of the latest updates to the rule.

updated_bystring nullable

The identifier for the user who was the last to update the rule.