GetAlertRule
Retrieve a single alert rule by its unique identifier
/api/v1/alerting/rules/{ruleUuid}Operation ID
GetAlertRuleSince
1.0.0Execution Mode
SynchronousAuth Context
Auth RequiredAuth Context
Send these values as request headers when calling this API.
AuthorizationstringRequiredBearer Token
X-Tenant-IDstringX-Tenant-ID
Request Inputs
Path Parameters
ruleUuidStringRequiredUUID of the alert rule to retrieve
Responses
200 OKOn success, this API returns the following response structure.
uuidStringUnique identifier of the alert rule
Example: rule-abc123-def456
nameStringHuman-readable name of the alert rule
Example: High CPU Usage
descriptionStringDetailed description of what this rule monitors
Example: Triggers when CPU usage exceeds 90% for 5 minutes
resourceTypeStringType of resource being monitored (e.g. vm, host, volume)
Example: vm
metricNameStringName of the metric to evaluate
Example: cpu_usage_percent
operatorStringComparison operator for threshold evaluation
Example: >
thresholdLongThreshold value that triggers the alert
Example: 90
durationIntegerDuration in seconds the condition must hold before firing
Example: 300
severityStringAlert severity level (critical, warning, info)
Example: critical
stateStringCurrent state of the rule (enabled, disabled, firing)
Example: enabled
notifyUrlStringWebhook URL for delivery notifications
Example: https://example.com/callback
platformUuidStringUUID of the platform this rule belongs to
Example: plat-001-abc
typeStringRule type: metric or log
Example: metric
logQueryStringLog query expression for log-based alert rules
Example: level=error AND service=payment
logWindowIntegerTime window in seconds for log query evaluation
Example: 600
categoryStringCategory grouping for the rule (e.g. infrastructure, application)
Example: infrastructure
labelSelectorsListScope selectors with In/NotIn operators and one or more values per key.
Example: (nested array)
keyStringMetric label key used to narrow the rule scope.
Example: value
operatorStringMatch operator. Supported values are In and NotIn.
Example: value
valuesListOne or more label values matched by the operator.
Example: item1,item2
sourceStringSource of the rule (builtin or custom)
Example: builtin
impactScopeStringScope of impact when this alert fires
Example: cluster
createDateStringTimestamp when the rule was created
Example: 2026-01-15T08:00:00Z
lastOpDateStringTimestamp of the last modification to this rule
Example: 2026-01-15T08:00:00Z
adapterTypeStringAdapter type for the monitoring backend
Example: prometheus
userModifiedBooleanWhether the user has manually modified this rule
Example: false
deprecatedBooleanWhether this rule is deprecated and should not be used
Example: false
createdByStringAccount ID of the user who created this rule
Example: admin
lastModifiedByStringAccount ID of the user who last modified this rule
Example: admin
actionsListActions attached to this rule (FIX-02: RI-AA-V02)
Example: (nested array)
uuidStringUnique identifier of the action
Example: action-001
ruleUuidStringUUID of the parent alert rule
Example: rule-abc123-def456
typeStringAction type: command_snippet, link, or text_suggestion
Example: command_snippet
labelStringDisplay label for the action button
Example: Restart Service
contentStringAction content (command, URL, or suggestion text)
Example: systemctl restart nginx
orderIndexIntegerDisplay order index for multiple actions
Example: 1
createDateStringTimestamp when the action was created
Example: 2026-01-15T08:00:00Z
productTypeStringProduct type for this resource
Example: value
resourceSubTypeStringResource sub type for this resource
Example: value
sourceSystemStringSource system for this resource
Example: value
sourceAlarmUuidStringSource alarm uuid for this resource
Example: value
sourceAlarmNameStringSource alarm name for this resource
Example: value
sourceNamespaceStringSource namespace for this resource
Example: value
sourceMetricNameStringSource metric name for this resource
Example: value
sourceLabelsStringSource labels for this resource
Example: value
filterRulesStringFilter rules for this resource
Example: value
conditionTypeStringCondition type for this resource
Example: value
thresholdUnitStringThreshold unit for this resource
Example: value
rawPeriodIntegerRaw period for this resource
Example: 10
rawEmergencyLevelStringRaw emergency level for this resource
Example: value
ruleStatusStringRule status for this resource
Example: value
prometheusMetricStatusStringPrometheus metric status for this resource
Example: value
defaultConfigSnapshotStringDefault config snapshot for this resource
Example: value
sourceRawPayloadStringSource raw payload for this resource
Example: value
