Skip to main content

Stream Change Staging Events

GET 
/deployments/changes/:id/stream

Stream events from the change staging process for the given change set ID. This will return a stream of events as they occur or that have recently occurred over the Server-Sent Events (SSE) protocol. The Last-Event-ID header can be used to resume the stream from a specific event ID.

Request​

Responses​

A server-sent event stream containing events from staging changes for a blueprint deployment. The data, event and id represents fields in the SSE specification, this is not a JSON object. The data field contains the payload of the event, which is a serialised JSON object that contains the details of the change staging event.

For example, the event stream will look like this:

event: resourceChanges
id: 60d7c6c5-3984-42b9-a3c1-ae8a47a9bf55
data: {"resourceName":"my-resource","removed":false,"new":false,"changes":{},"resolveOnDeploy":[],"conditionKnownOnDeploy":false,"timestamp":1678901234}

event: childChanges
id: 62d3cac5-3984-42b9-a3c1-ae8a47a9bf33
data: {"childBlueprintName":"my-child-blueprint","removed":false,"new":false,"changes":{},"timestamp":1678901234}