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

AcknowledgeAlertEvent

Acknowledge an alert event to indicate it is being investigated

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 acknowledge

Body Fields

  • acknowledgedByStringRequired

    User acknowledging the alert

    Example: admin

  • commentStringRequired

    Optional comment with the acknowledgement

    Example: Investigating the issue

Responses

200 OK

On success, this API returns the following response structure.

  • 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

Endpoint

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

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

Operation ID

AcknowledgeAlertEvent

Permalink

Request Example

curl -X POST '{host}/api/v1/alerting/events/{eventId}/acknowledge' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"acknowledgedBy":"admin","comment":"Investigating the issue"}'

Response Example

200
{
  "uuid": "event-001",
  "ruleUuid": "rule-abc123",
  "ruleName": "High CPU Usage",
  "resourceType": "vm",
  "resourceUuid": "res-abc123",
  "metricName": "cpu_usage_percent",
  "currentValue": 95.3,
  "threshold": 90.0
}

Change History

This API has no change history records yet.

View all change history