Bluelink
HTTP API Referencev1

Stream Deployment Events

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.

GET
/deployments/instances/{id}/stream
AuthorizationBearer <token>

OAuth2/OIDC auth using JWT Bearer tokens. The token issuer will be configured independently for each Deploy Engine instance.

In: header

Path Parameters

idstring

The ID of the blueprint instance.

Header Parameters

Bluelink-Signature-V1?string

The Bluelink Signature v1 authentication mechanism can be used to authenticate requests to the Deploy Engine. See the Bluelink Signature v1 documentation for more information on how to use this authentication mechanism. This is not required if the request is authenticated using an OAuth2/OIDC-issued JWT or an API key.

Last-Event-ID?string

The ID of the last event received. This can be used to resume the stream from a specific event ID.

Response Body

curl -X GET "https://{host}/{basePath}/v1/deployments/instances/16ef8989-af00-4a4a-8164-72493ceb1aa0/stream" \  -H "Bluelink-Signature-V1: string" \  -H "Last-Event-ID: 60d7c6c5-3984-42b9-a3c1-ae8a47a9bf55"
{
  "event": "resource",
  "id": "60d7c6c5-3984-42b9-a3c1-ae8a47a9bf55",
  "data": {
    "instanceId": "16ef8989-af00-4a4a-8164-72493ceb1aa0",
    "resourceId": "16ef8989-af00-4a4a-8164-72493ceb1aa0",
    "resourceName": "my-resource",
    "group": 1,
    "status": 2,
    "preciseStatus": 3,
    "failureReasons": [
      "Invalid configuration for resource spec"
    ],
    "attempt": 1,
    "canRetry": false,
    "updateTimestamp": 1678901234,
    "durations": {
      "configCompleteDuration": 10000,
      "totalDuration": 20000,
      "attemptDurations": [
        20000
      ]
    }
  }
}
{
  "message": "Unauthorized"
}
{
  "message": "Not found"
}
{
  "message": "An unexpected error occurred"
}