Skip to main content

Stream Deployment Events

GET 
/deployments/instances/:id/stream

Stream events from the current deployment process for the given blueprint instance ID.

This will stream events for new deployments, updates and for destroying a blueprint instance.

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.

For a blueprint instance that has been destroyed, this stream will no longer be available to new connections once the destroy process has been succesfully completed.

Request​

Responses​

A server-sent event stream containing events for a blueprint instance 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: resource
id: 60d7c6c5-3984-42b9-a3c1-ae8a47a9bf55
data: {"instanceId":"16ef8989-af00-4a4a-8164-72493ceb1aa0","resourceId":"60d7c6c5-3984-42b9-a3c1-ae8a47a9bf55","resourceName":"my-resource","status":2,"preciseStatus":3,"group":1,"attempt":2,"canRetry":false,"updateTimestamp":1678901234,"durations":{"attemptDurations":[102,302.5],"totalDuration":404.5}}

event: child
id: 62d3cac5-3984-42b9-a3c1-ae8a47a9bf33
data: {"parentInstanceId":"16ef8989-af00-4a4a-8164-72493ceb1aa0","childInstanceId":"02214a31-e507-4b5f-955d-dfac8f70e6a8","childName":"coreInfra","status":13,"updateTimestamp":1678901234}