Documentation menu
Environment Changes

Stream changes from the last acknowledged cursor

GET /api/v1/projects/{projectId}/environments/{environmentId}/changes/consumers/{consumerId}/stream

SSE changes frames contain the same page as long polling. Acknowledge a page only after processing it. Streams close after 30 seconds; reconnect from durable acknowledgement. Last-Event-ID never acknowledges changes. A rebaseline frame requires a fresh consumer and state query; an error frame closes the stream.

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Stream changes from the last acknowledged cursor.
environmentIdstringrequiredIdentifies the Project environment addressed by the operation. Applies to Stream changes from the last acknowledged cursor.
consumerIdstringrequiredIdentifies a durable change consumer owned by the authenticated user. Applies to Stream changes from the last acknowledged cursor.

query

NameTypeRequiredDescription
limitintegeroptionalSets the maximum number of resources returned in this page. Applies to Stream changes from the last acknowledged cursor.

Responses

StatusDescriptionBody
200text/event-streamtext/event-stream — string
400The request is malformed or cannot be processed.application/json — PublicApiError — error: object (required)
401Authentication failed. The Authorization header is missing, or the credential is invalid or expired.application/json — PublicApiError — error: object (required)
403Access denied. The authenticated user does not have permission to perform this action.application/json — PublicApiError — error: object (required)
404Resource not found.application/json — PublicApiError — error: object (required)
409Request conflicts with current state of the resource, including safe deployment conflict classifications.application/json — PublicApiError — error: object (required)
422Request validation failed. Check the request body, query parameters, or path parameters.application/json — PublicApiError — error: object (required)
429Too many requests.application/json — PublicApiError — error: object (required)
500The server could not complete the request.application/json — PublicApiError — error: object (required)
503Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.application/json — PublicApiError — error: object (required)