GetPlatformEvent
Get one authorized platform event with original payload, parsing information and channel delivery records. Display fields follow Accept-Language negotiation and fallback; cause and solution remain empty. Original identity codes (productType, namespace, eventName, resourceType, severity) and rawPayload are unchanged.
/api/v1/alerting/platform-events/{uuid}Operation ID
GetPlatformEventSince
1.3.0Execution Mode
SynchronousAuth Context
Auth RequiredAuth Context
Send these values as request headers when calling this API.
AuthorizationstringRequiredBearer Token
X-Tenant-IDstringX-Tenant-ID
Request Inputs
Path Parameters
uuidStringRequiredPersisted event record UUID
Responses
200 OKOn success, this API returns the following response structure.
uuidStringPersisted event record identity
Example: record-1
platformUuidStringSource platform identity
Example: platform-1
productTypeStringSource product type
Example: cloud
sourceSystemStringSource system identifier
Example: zstack
sourceEventIdStringSource event identity; empty when unavailable
Example: source-event-1
namespaceStringSource namespace
Example: ZStack/Host
eventNameStringSource event name
Example: HostConnected
resourceTypeStringMapped resource type
Example: Host
resourceUuidStringSource resource UUID
Example: host-1
resourceNameStringResource display name
Example: Host A
severityStringEvent severity
Example: info
recordTypeStringRecord classification; distinct from notification delivery state
Example: notify
recordedAtStringPersisted record creation time used for filtering and default descending order
Example: 2026-09-17T00:00:00Z
occurredAtStringActual source occurrence time; absent when unknown
Example: 2026-09-16T23:59:59Z
messageStringLocalized 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
parseErrorStringParsing or classification error; empty for normal notify records
Example: event namespace is missing
rawPayloadObjectOriginal stored event payload, included in list and detail responses
Example: (nested object)
deliveryRecordsListChannel delivery attempts ordered by createdAt DESC, uuid DESC; populated only for event detail
uuidStringUUID of the alert delivery record
Example: value
notificationGroupIdStringNotification group id for this resource
Example: value
alertInstanceIdsListAlert instance ids for this resource
Example: item1,item2
alertInstanceUuidStringAlert instance uuid for this resource
Example: value
policyUuidStringPolicy uuid for this resource
Example: value
channelUuidStringChannel uuid for this resource
Example: value
channelTypeStringChannel type for this resource
Example: value
templateUuidStringTemplate uuid for this resource
Example: value
targetMaskedStringTarget masked for this resource
Example: value
statusStringStatus for this resource
Example: value
attemptIntegerAttempt for this resource
Example: 10
maxAttemptsIntegerMax attempts for this resource
Example: 10
errorCodeStringError code for this resource
Example: value
errorMessageStringError message for this resource
Example: value
durationMsIntegerDuration ms for this resource
Example: 10
createdAtStringCreated at for this resource
Example: 2026-01-15T08:00:00Z
lastAttemptAtStringLast attempt at for this resource
Example: 2026-01-15T08:00:00Z
nextRetryAtStringNext retry at for this resource
Example: 2026-01-15T08:00:00Z
sentAtStringSent at for this resource
Example: 2026-01-15T08:00:00Z
providerMessageIdStringProvider message id for this resource
Example: value
suppressionTypeStringSuppression type for this resource
Example: value
suppressionPolicyIdStringSuppression policy id for this resource
Example: value
suppressionReasonStringSuppression reason for this resource
Example: value
suppressedAtStringSuppressed at for this resource
Example: 2026-01-15T08:00:00Z
deliveryKindStringDelivery kind for this resource
Example: value
contentTruncatedBooleanContent truncated for this resource
Example: true
originalAlertCountIntegerOriginal alert count for this resource
Example: 10
renderedAlertCountIntegerRendered alert count for this resource
Example: 10
providerRequestIdStringProvider request id for this resource
Example: value
providerDeliveryIdStringProvider delivery id for this resource
Example: value
providerAcceptedAtStringProvider accepted at for this resource
Example: 2026-01-15T08:00:00Z
providerConfirmationStatusStringProvider confirmation status for this resource
Example: value
providerErrorCodeStringProvider error code for this resource
Example: value
confirmedAtStringConfirmed at for this resource
Example: 2026-01-15T08:00:00Z
eventRecordUuidStringPlatform event record UUID; empty for resource and test deliveries.
Example: value
ackStateStringHuman attention acknowledgement: Unack or Ack; independent of recovery and delivery
Example: Unack
acknowledgedByStringStable verified identifier of the first acknowledging user; empty before acknowledgement or when acknowledged anonymously under optional user authentication
Example: user-1
acknowledgedAtStringServer acknowledgement time; absent before acknowledgement
Example: 2026-09-20T00:00:00Z
nameStringDisplay name localized using Accept-Language and the complete product_type, namespace, event_name identity; falls back to the original event_name.
Example: Host Connected
impactScopeStringLocalized impact scope; empty when no authoritative product description is available.
Example: value
descriptionStringLocalized event description; empty when no authoritative product description is available.
Example: A brief description
summaryStringLocalized summary using persisted event facts; falls back to the original event message.
Example: value
causeStringReserved display field; explicitly returned as an empty string.
solutionStringReserved display field; explicitly returned as an empty string.
resourceTypeDisplayNameStringLocalized resource type label consistent with the platform event resource-types directory; resource_type keeps its original code. Falls back to resource_type.
Example: Host
Change History
View all change historyChange Time
AddedRequest parameters Accept-LanguageAddedResponse fields cause, description, impactScope...View API
