Documentation menu

Project Environment Events

2 operations.

MethodEndpointDescription
GET/api/v1/projects/{projectId}/environments/{environmentId}/eventsList retained Environment events
POST/api/v1/projects/{projectId}/environments/{environmentId}/events/rebaselineCreate an Environment event-tail baseline

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

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to List retained Environment events.
environmentIdstringrequiredIdentifies the Project environment addressed by the operation. Applies to List retained Environment events.

query

NameTypeRequiredDescription
cursorstringoptionalOpaque cursor returned by the previous page; omit it to read the first page. Applies to List retained Environment events.
cursorVersion"1" | "2"optionalEvent 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.
limitintegeroptionalSets the maximum number of resources returned in this page. Applies to List retained Environment events.

Responses

StatusDescriptionBody
200Response for status 200application/json — object — cursorVersion: 2; readPosition: object; events: array<object> (required); pagination: object (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)

Create an Environment event-tail baseline

POST /api/v1/projects/{projectId}/environments/{environmentId}/events/rebaseline

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Create an Environment event-tail baseline.
environmentIdstringrequiredIdentifies the Project environment addressed by the operation. Applies to Create an Environment event-tail baseline.

query

NameTypeRequiredDescription
cursorVersion"1" | "2"optionalEvent 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 Create an Environment event-tail baseline.

Responses

StatusDescriptionBody
200Response for status 200application/json — object — cursorVersion: 2; readPosition: object; checkpointId: integer (required); checkpointGeneration: integer (required); baseline: object (required); resumeCursor: string (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)