Project Environment Events
2 operations.
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v1/projects/{projectId}/environments/{environmentId}/events | List retained Environment events |
| POST | /api/v1/projects/{projectId}/environments/{environmentId}/events/rebaseline | Create 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.
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. |
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 — 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. The code foreign_resource_rate_limited means the caller made too many requests for Projects outside its reach: correct the Project id instead of retrying. | 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) |
Create an Environment event-tail baseline
POST /api/v1/projects/{projectId}/environments/{environmentId}/events/rebaseline
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Create an Environment event-tail baseline. |
environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to Create an Environment event-tail baseline. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Response for status 200 | application/json — object — checkpointId: integer (required); checkpointGeneration: integer (required); baseline: object (required); resumeCursor: string (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. The code foreign_resource_rate_limited means the caller made too many requests for Projects outside its reach: correct the Project id instead of retrying. | 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) |