Kyvernon

Reference For: developers

API: events

Operations of the events tag of the native REST API.

Events

GET /v1/events

Lists events, oldest first or with order=desc newest first; after takes the next cursor of the previous page. Events of deleted entities stay listed (with the entity name they were logged with) for callers with System.View on the root.

CLI
kyvernon events list

Parameters

NameInTypeRequiredDescription
targetquerystring or nullOnly events on this target.
recursivequeryboolean or nullInclude descendants of target.
eventTypequerystring or nullComma-separated event types.
userquerystring or nullOnly this user.
chainIdquerystring or nullOnly this chain id.
beginquerystring or nullEvents at or after (RFC 3339).
endquerystring or nullEvents at or before (RFC 3339).
minSeverityquerystring or nullMinimum severity (info, warning, error).
afterIdqueryinteger (int64) or nullCollector cursor: only events with id number greater than this.
orderquerystring or nullasc (default, oldest first) or desc (newest first).
limitqueryinteger or nullMaximum items.
afterquerystring or nullCursor: the next of the previous page (in the same order).

Responses

StatusDescriptionSchema
200OKPaged_EventView

POST /v1/events

Injects a typed event into the native event log (PostEvent).

CLI
kyvernon events post --body <json>

Request body

application/json: PostEventRequest

NameTypeRequiredDescription
attributesobjectExtra attributes.
chainIdstring or nullCorrelation id; a new id is allocated when omitted.
entityIdstring or nullOptional target inventory object id.
eventTypestringyesEvent type in vSphere style (GeneralUserEvent, EventEx, …).
messagestring or nullFree-form message text (stored as message arg msg when set).
messageIdstring or nullLocalisable message key; defaults to event.user when message is set, else event.posted.
severitySeverityView or null

Responses

StatusDescriptionSchema
201CreatedEventView

POST /v1/events/user

Appends a user event on an inventory entity (LogUserEvent).

CLI
kyvernon events log <entity> <message>

Request body

application/json: LogUserEventRequest

NameTypeRequiredDescription
entityIdstringyesTarget inventory object id.
messagestringyesFree-form message text shown to operators.

Responses

StatusDescriptionSchema
201CreatedEventView

Version 0.1.