#AlertHistories [v1]

/v1/alerthistories#

getGet alert histories#

Retrieve a list of alert histories based on specified filters.

Parameters#

• start(in query): integerrequired

  Start time for querying alert histories (timestamp). Required.

• end(in query): integerrequired

  End time for querying alert histories (timestamp). Required.

• alertKind(in query): string

  Type of alert (resource or event). Optional, defaults to all.

• alertStrategy(in query): string

  Alert strategy to filter by. Optional, defaults to all.

• alertObjectKind(in query): string

  Resource type of the alert object. Optional, defaults to all.

• alertObjectName(in query): string

  Resource name of the alert object. Optional, defaults to all.

• alertObjectCluster(in query): string

  Cluster of the alert object. Required for Node/Deployment/Statefulset/Daemonset. Optional, defaults to all.

• alertObjectNamespace(in query): string

  Namespace of the alert object. Required for Deployment/Statefulset/Daemonset. Optional, defaults to all.

• page(in query): integer

  Page number to retrieve. Optional, defaults to 1.

• pageSize(in query): integer

  Number of items per page. Optional, defaults to 20.

• orderBy(in query): string

  Field to sort results by. Optional, defaults to -startsAt.

Response#

• 200AlertHistory: Successful response with list of alert histories.

AlertHistory#

• next: string

  URL for the next page of results.

• previous: string

  URL for the previous page of results.

• page_size: integer

  Number of items per page.

• num_pages: integer

  Total number of pages.

• count: integer

  Total number of results.

• results: []AlertHistoryResult

AlertHistoryResult#

• alertHistoryName: string

  Key for the alert history.

• alertName: string

  Name of the alert rule.

• alertStrategy: AlertHistoryStrategy
• involvedObject: AlertHistoryInvolvedObject
• labels: AlertHistoryLabels
• messagesCount: integer

  Number of alert occurrences.

• startsAt: string

  Start time of the alert.

• endsAt: string

  End time of the alert.

AlertHistoryStrategy#

• name: string

  Name of the alert strategy.

• namespace: string

  Namespace of the alert strategy.

AlertHistoryInvolvedObject#

• cluster: string

  Cluster of the involved resource.

• kind: string

  Type of the involved resource.

• name: string

  Name of the involved resource.

• namespace: string

  Namespace of the involved resource.

AlertHistoryLabels#

• alert_cluster: string

  Cluster of the alert rule.

• alert_project: string

  Project of the alert rule.

• alert_namespace: string

  Namespace of the alert rule.

• alert_resource: string

  Name of the alert strategy.

• alert_name: string

  Name of the alert rule.

• alert_involved_object_kind: string

  Kind of the involved resource.

• alert_involved_object_namespace: string

  Namespace of the involved resource.

• alert_involved_object_name: string

  Name of the involved resource.

• alert_indicator: string

  Indicator for the alert rule.

• alert_indicator_comparison: string

  Comparison operator for the alert rule.

• alert_indicator_threshold: string

  Threshold for the alert rule.

• alert_indicator_unit: string

  Unit for the alert rule.

• severity: string

  Severity level of the alert.