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

GetAlertEventDetail

Get detailed information about a specific alert event including comments and timeline

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • eventIdStringRequired

    Event identifier to retrieve details for

Responses

200 OK

On success, this API returns the following response structure.

  • alertObject

    The alert event

    • uuidString

      Unique identifier of the alert event

      Example: event-001

    • ruleUuidString

      UUID of the rule that generated this event

      Example: rule-abc123

    • ruleNameString

      Name of the rule that generated this event

      Example: High CPU Usage

    • resourceTypeString

      Type of monitored resource

      Example: vm

    • resourceUuidString

      UUID of the specific resource

      Example: res-abc123

    • metricNameString

      Metric name that was evaluated

      Example: cpu_usage_percent

    • currentValueLong

      Current metric value at the time of the event

      Example: 95.3

    • thresholdLong

      Threshold that was exceeded

      Example: 90

    • operatorString

      Comparison operator used

      Example: >

    • severityString

      Severity level of the event

      Example: critical

    • stateString

      Current state: firing, acknowledged, or resolved

      Example: firing

    • messageString

      Human-readable event message

      Example: CPU usage is 95.3%

    • fingerprintString

      Unique fingerprint for deduplication

      Example: fp-abc123

    • sourceString

      Source system that generated the event

      Example: prometheus

    • notifiedAtString

      Timestamp when the notification was sent

      Example: 2026-01-15T08:00:00Z

    • resolvedAtString

      Timestamp when the event was resolved

      Example: 2026-01-15T08:00:00Z

    • acknowledgedByString

      User who acknowledged this event

      Example: admin

    • acknowledgedAtString

      Timestamp when the event was acknowledged

      Example: 2026-01-15T08:00:00Z

    • createDateString

      Timestamp when the event was created

      Example: 2026-01-15T08:00:00Z

  • commentsList

    Comments on the alert event

    Example: (nested array)

    • uuidString

      Unique identifier of the comment

      Example: comment-001

    • alertUuidString

      Alert event UUID this comment belongs to

      Example: event-001

    • authorString

      Author of the comment

      Example: admin

    • contentString

      Comment content text

      Example: Investigating high CPU on db-01

    • createDateString

      Timestamp when the comment was created

      Example: 2026-01-15T08:00:00Z

  • timelineList

    Timeline of actions on the alert event

    Example: (nested array)

    • uuidString

      Unique identifier of the timeline entry

      Example: timeline-001

    • alertUuidString

      Alert event UUID this entry belongs to

      Example: event-001

    • actionString

      Action performed (created, acknowledged, resolved, commented)

      Example: acknowledged

    • actorString

      User who performed the action

      Example: admin

    • detailString

      Additional detail about the action

      Example: Alert acknowledged by admin

    • createDateString

      Timestamp of the action

      Example: 2026-01-15T08:00:00Z

Endpoint

GET/api/v1/alerting/events/{eventId}

/api/v1/alerting/events/{eventId}

Operation ID

GetAlertEventDetail

Permalink

Request Example

curl -X GET '{host}/api/v1/alerting/events/{eventId}' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "alert": {},
  "comments": [
    {}
  ],
  "timeline": [
    {}
  ]
}

Change History

This API has no change history records yet.

View all change history