Documentation menu

System Agent Events

2 operations.

MethodEndpointDescription
GET/api/v1/agents/{coordinator}/eventsList retained discoverable System Agent events
POST/api/v1/agents/{coordinator}/events/rebaselineCreate a discoverable System Agent event-tail baseline

List retained discoverable System Agent events

GET /api/v1/agents/{coordinator}/events

Parameters

path

NameTypeRequiredDescription
coordinatorstringrequiredIdentifies the coordinator agent by its canonical name. Applies to List retained discoverable System Agent events.

query

NameTypeRequiredDescription
cursorstringoptionalOpaque cursor returned by the previous page; omit it to read the first page. Applies to List retained discoverable System Agent events.
limitintegeroptionalSets the maximum number of resources returned in this page. Applies to List retained discoverable System Agent events.

Responses

StatusDescriptionBody
200Response for status 200application/json — 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. 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)
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 a discoverable System Agent event-tail baseline

POST /api/v1/agents/{coordinator}/events/rebaseline

Parameters

path

NameTypeRequiredDescription
coordinatorstringrequiredIdentifies the coordinator agent by its canonical name. Applies to Create a discoverable System Agent event-tail baseline.

Responses

StatusDescriptionBody
200Response for status 200application/json — 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. 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)
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)