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

AddAlertEventComment

Add a comment to an alert event for collaboration and audit trail

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 add comment to

Body Fields

  • authorStringRequired

    Comment author

    Example: admin

  • contentStringRequired

    Comment content text

    Example: Checking logs for root cause

Responses

200 OK

On success, this API returns the following response structure.

  • 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

Endpoint

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

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

Operation ID

AddAlertEventComment

Permalink

Request Example

curl -X POST '{host}/api/v1/alerting/events/{eventId}/comments' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"author":"admin","content":"Checking logs for root cause"}'

Response Example

200
{
  "uuid": "comment-001",
  "alertUuid": "event-001",
  "author": "admin",
  "content": "Investigating high CPU on db-01",
  "createDate": "example"
}

Change History

This API has no change history records yet.

View all change history