ListPlatformEvents

On success, this API returns the following response structure.

• items

  List

  Authorized event records ordered by recordedAt DESC, uuid DESC

  Show child properties
  • uuid

    String

    Persisted event record identity

    Example: record-1

  • platformUuid

    String

    Source platform identity

    Example: platform-1

  • productType

    String

    Source product type

    Example: cloud

  • sourceSystem

    String

    Source system identifier

    Example: zstack

  • sourceEventId

    String

    Source event identity; empty when unavailable

    Example: source-event-1

  • namespace

    String

    Source namespace

    Example: ZStack/Host

  • eventName

    String

    Source event name

    Example: HostConnected

  • resourceType

    String

    Mapped resource type

    Example: Host

  • resourceUuid

    String

    Source resource UUID

    Example: host-1

  • resourceName

    String

    Resource display name

    Example: Host A

  • severity

    String

    Event severity

    Example: info

  • recordType

    String

    Record classification; distinct from notification delivery state

    Example: notify

  • recordedAt

    String

    Persisted record creation time used for filtering and default descending order

    Example: 2026-09-17T00:00:00Z

  • occurredAt

    String

    Actual source occurrence time; absent when unknown

    Example: 2026-09-16T23:59:59Z

  • message

    String

    Localized event message in read responses; the stored message and original raw_payload remain unchanged. Falls back to the original message when translation is unavailable.

    Example: Host connected

  • parseError

    String

    Parsing or classification error; empty for normal notify records

    Example: event namespace is missing

  • rawPayload

    Object

    Original stored event payload, included in list and detail responses

    Example: (nested object)

  • deliveryRecords

    List

    Channel delivery attempts ordered by createdAt DESC, uuid DESC; populated only for event detail

    Show child properties
    • uuid

      String

      UUID of the alert delivery record

      Example: value

    • notificationGroupId

      String

      Notification group id for this resource

      Example: value

    • alertInstanceIds

      List

      Alert instance ids for this resource

      Example: item1,item2

    • alertInstanceUuid

      String

      Alert instance uuid for this resource

      Example: value

    • policyUuid

      String

      Policy uuid for this resource

      Example: value

    • channelUuid

      String

      Channel uuid for this resource

      Example: value

    • channelType

      String

      Channel type for this resource

      Example: value

    • templateUuid

      String

      Template uuid for this resource

      Example: value

    • targetMasked

      String

      Target masked for this resource

      Example: value

    • status

      String

      Status for this resource

      Example: value

    • attempt

      Integer

      Attempt for this resource

      Example: 10

    • maxAttempts

      Integer

      Max attempts for this resource

      Example: 10

    • errorCode

      String

      Error code for this resource

      Example: value

    • errorMessage

      String

      Error message for this resource

      Example: value

    • durationMs

      Integer

      Duration ms for this resource

      Example: 10

    • createdAt

      String

      Created at for this resource

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

    • lastAttemptAt

      String

      Last attempt at for this resource

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

    • nextRetryAt

      String

      Next retry at for this resource

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

    • sentAt

      String

      Sent at for this resource

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

    • providerMessageId

      String

      Provider message id for this resource

      Example: value

    • suppressionType

      String

      Suppression type for this resource

      Example: value

    • suppressionPolicyId

      String

      Suppression policy id for this resource

      Example: value

    • suppressionReason

      String

      Suppression reason for this resource

      Example: value

    • suppressedAt

      String

      Suppressed at for this resource

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

    • deliveryKind

      String

      Delivery kind for this resource

      Example: value

    • contentTruncated

      Boolean

      Content truncated for this resource

      Example: true

    • originalAlertCount

      Integer

      Original alert count for this resource

      Example: 10

    • renderedAlertCount

      Integer

      Rendered alert count for this resource

      Example: 10

    • providerRequestId

      String

      Provider request id for this resource

      Example: value

    • providerDeliveryId

      String

      Provider delivery id for this resource

      Example: value

    • providerAcceptedAt

      String

      Provider accepted at for this resource

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

    • providerConfirmationStatus

      String

      Provider confirmation status for this resource

      Example: value

    • providerErrorCode

      String

      Provider error code for this resource

      Example: value

    • confirmedAt

      String

      Confirmed at for this resource

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

    • eventRecordUuid

      String

      Platform event record UUID; empty for resource and test deliveries.

      Example: value

  • ackState

    String

    Human attention acknowledgement: Unack or Ack; independent of recovery and delivery

    Example: Unack

  • acknowledgedBy

    String

    Stable verified identifier of the first acknowledging user; empty before acknowledgement or when acknowledged anonymously under optional user authentication

    Example: user-1

  • acknowledgedAt

    String

    Server acknowledgement time; absent before acknowledgement

    Example: 2026-09-20T00:00:00Z

  • name

    String

    Display name localized using Accept-Language and the complete product_type, namespace, event_name identity; falls back to the original event_name.

    Example: Host Connected

  • impactScope

    String

    Localized impact scope; empty when no authoritative product description is available.

    Example: value

  • description

    String

    Localized event description; empty when no authoritative product description is available.

    Example: A brief description

  • summary

    String

    Localized summary using persisted event facts; falls back to the original event message.

    Example: value

  • cause

    String

    Reserved display field; explicitly returned as an empty string.

  • solution

    String

    Reserved display field; explicitly returned as an empty string.

  • resourceTypeDisplayName

    String

    Localized resource type label consistent with the platform event resource-types directory; resource_type keeps its original code. Falls back to resource_type.

    Example: Host

• total

  String

  Total authorized matching records

  Example: 20

• limit

  Integer

  Applied page size

  Example: 20

• offset

  Integer

  Applied row offset

  Example: 20