Sign in

v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB
Alerts

List alert logs

This endpoint is used to retrieve a paginated list of alert logs which provides users to obtain a comprehensive record of alert activities. This includes alert creation, acknowledgment, assignment, and closure details. This endpoint is crucial for audit purposes, incident reviews, and enhancing the overall incident management process by providing complete visibility into alert history.

get/api/{cloudId}/v1/alerts/{id}/logs

Path parameters

idstring required

Identifier of the alert.

Query parameters

afterstring

This parameter is used in pagination for the alert logs retrieved by the system. It accepts a string key of the last record from the previous page. The system will return the next page of logs that come after this specified key. This is useful for fetching subsequent segments of data when there are more logs than the limit specified.

sizeinteger

This parameter is used to limit the number of alert logs returned by the system. It accepts an integer that specifies the maximum number of logs to be retrieved.

Response

Returned if the request is successful.

Example response

{
  "values": [
    {
      "logTime": "2024-01-05T07:06:47.958Z",
      "logType": "system",
      "log": "Assigning owner team [Dream] to alert because it is the only team on the alert and alert is not created via team integration.",
      "owner": "system"
    }
  ],
  "links": {
    "next": "/v1/alerts/4513b7ea-3b91-438f-b7e4-e3e54af9147c/logs?after=1492000072838_1492000072838234593"
  }
}