List retained Environment events
GET /api/v1/projects/{projectId}/environments/{environmentId}/events
Read the ordered event history retained for a Project Environment using an opaque cursor.
Omit cursor for the initial read and persist pagination.resumeCursor
after every response. When hasMore is true, use pagination.nextCursor
to retrieve the remaining events from that same pull. Empty pages still return a valid resume
cursor for the requested position.
Snapshot read capability is opt-in: request cursorVersion=2 on rebaseline.
List requests infer the signed cursor version when the selector is omitted;
an explicit selector must match that cursor.
Process each page before saving its next cursor; save the resume cursor only
after the final page. Retries replay that fixed snapshot delta, including its final
page. Append identity orders a single delta and may decrease between polls;
legacy sequence fields and publication generation remain event provenance.
A retryable 409 conflict with details.conflictReason=concurrent_commit
requires retrying the same request with the same cursor to replay the winning delta.
A 409 rebaseline_required requires a fresh state baseline. Retention checks
can conservatively require rebaseline even for events already processed.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
projectId | string | required | Identifies the Project that owns the addressed resource. Applies to List retained Environment events. |
environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to List retained Environment events. |
query
| Name | Type | Required | Description |
|---|---|---|---|
cursor | string | optional | Opaque cursor returned by the previous page; omit it to read the first page. Applies to List retained Environment events. |
cursorVersion | "1" | "2" | optional | Event cursor protocol version. Without a cursor, default 1 preserves legacy behavior. Opt in to 2 on rebaseline; list requests infer the signed cursor version when the selector is omitted. An explicit selector must match the cursor. On retryable 409 conflict with concurrent_commit, retry the same request with the same cursor, if supplied. On 409 rebaseline_required, fetch a fresh baseline. Applies to List retained Environment events. |
limit | integer | optional | Sets the maximum number of resources returned in this page. Applies to List retained Environment events. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Response for status 200 | application/json — object — cursorVersion: 2; readPosition: object; events: array<object> (required); pagination: object (required) |
400 | The request is malformed or cannot be processed. | application/json — PublicApiError — error: object (required) |
401 | Authentication failed. The Authorization header is missing, or the credential is invalid or expired. | application/json — PublicApiError — error: object (required) |
403 | Access denied. The authenticated user does not have permission to perform this action. | application/json — PublicApiError — error: object (required) |
404 | Resource not found. | application/json — PublicApiError — error: object (required) |
409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json — PublicApiError — error: object (required) |
422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json — PublicApiError — error: object (required) |
429 | Too many requests. | application/json — PublicApiError — error: object (required) |
500 | The server could not complete the request. | application/json — PublicApiError — error: object (required) |
503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json — PublicApiError — error: object (required) |