Documentation menu
Environment Changes

Long-poll changes from the last acknowledged cursor

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

An interrupted response is replayed. Acknowledge the returned cursor only after processing the complete page. A 409 requires a new baseline.

Parameters

path

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

query

NameTypeRequiredDescription
limitintegeroptionalSets the maximum number of resources returned in this page. Applies to Long-poll changes from the last acknowledged cursor.
waitMsintegeroptionalSets the maximum long-poll wait for newly published changes, in milliseconds. Applies to Long-poll changes from the last acknowledged cursor.

Responses

StatusDescriptionBody
200Response for status 200application/json — object — changes: array<object> (required); cursor: string (required); position: string (required); hasMore: boolean (required)
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)