Skip to main content
API Explorer|API Explorer
Alerting & Response/Alert Rules
GETAlertingSince 1.0SynchronousAuth Required

GetAlertEscalationRule

Retrieve the logging escalation rule configuration for an alert rule

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • ruleIdStringRequired

    Alert rule identifier to retrieve escalation config for

Responses

200 OK

On success, this API returns the following response structure.

  • ruleIdString

    Alert rule identifier this escalation applies to

    Example: rule-abc123

  • enabledBoolean

    Whether this escalation rule is active

    Example: true

  • keywordsList

    Keyword patterns with associated severity levels

    Example: (nested array)

    • patternString

      Log keyword pattern to match

      Example: OutOfMemory

    • severityString

      Severity to assign when pattern matches

      Example: critical

  • windowSecondsInteger

    Time window in seconds for log evaluation

    Example: 300

  • minMatchCountInteger

    Minimum number of keyword matches to trigger escalation

    Example: 3

  • scheduleIdString

    Primary on-call schedule identifier

    Example: sched-001

  • escalateScheduleIdString

    Escalation target schedule identifier

    Example: sched-002

  • escalateAfterMinutesInteger

    Minutes before escalation triggers

    Example: 30

  • notifyContextBoolean

    Whether to include log context in notifications

    Example: true

Endpoint

GET/api/v1/alerting/rules/{ruleId}/logging-escalation

/api/v1/alerting/rules/{ruleId}/logging-escalation

Operation ID

GetAlertEscalationRule

Permalink

Request Example

curl -X GET '{host}/api/v1/alerting/rules/{ruleId}/logging-escalation' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "ruleId": "rule-abc123",
  "enabled": true,
  "keywords": [
    {}
  ],
  "windowSeconds": 300,
  "minMatchCount": 3,
  "scheduleId": "sched-001",
  "escalateScheduleId": "sched-002",
  "escalateAfterMinutes": 30
}

Change History

This API has no change history records yet.

View all change history