events

Submit an external event

Submit an external event to add to the event log.

post/events

Request body

subjectstring required

The object that is affected by the event (e.g. A cluster scale out event for cluster w234fs will have a subject of /v2/cluster/w234fs).

messagestring required

Text that describes the occurrence of an event.

severity'info' | 'severe' | 'warning' required

The severity of the event. There are three levels: info is informational and no action is needed, warning may indicate that an error will occur if action is not taken, severe is critical and requires immediate attention (e.g. the application is down).

typestring required

The type of event. For external events, the type may not begin with 'system-'.

detailsobject nullable

Optional additional structured information about this event.

originstring

The third-party entity that generated the event.

originatedstring

An iso8601 formatted timestamp

Response

The call was successful.

createdstring required

An iso8601 formatted timestamp

incidentstring required

The identifier for the underlying incident that triggered the event.

messagestring required

Text that describes the occurrence of an event.

severity'info' | 'severe' | 'warning' required

The severity of the event. There are three levels: info is informational and no action is needed, warning may indicate that an error will occur if action is not taken, severe is critical and requires immediate attention (e.g. the application is down).

subjectstring

The object that is affected by the event (e.g. A cluster scale out event for cluster w234fs will have a subject of /v2/cluster/w234fs).

typestring required

The type of event that has occurred.

originstring

The third-party entity that generated the event.

originatedstring

An iso8601 formatted timestamp

Changes

No recorded changes to this endpoint across all 1 revision of this API.