Skip to main content

events

Overview

Nameevents
TypeResource
Idlinode.account.events

Fields

NameDatatypeDescription
idintegerThe unique ID of this Event.
actionstringThe action that caused this Event. New actions may be added in the future.
createdstringWhen this Event was created.
durationnumberThe total duration in seconds that it takes for the Event to complete.
entityobjectDetailed information about the Event's entity, including ID, type, label, and URL used to access it.
messagestringProvides additional information about the event. Additional information may include, but is not limited to, a more detailed representation of events which can help diagnose non-obvious failures.
percent_completeintegerA percentage estimating the amount of time remaining for an Event.
Returns null for notification events.
ratestringThe rate of completion of the Event. Only some Events will return rate; for example, migration and resize Events.
readbooleanIf this Event has been read.
secondary_entityobjectDetailed information about the Event's secondary entity, which provides additional information
for events such as, but not limited to, linode_boot, linode_reboot, linode_create, and linode_clone Event actions.
seenbooleanIf this Event has been seen.
statusstringThe current status of this Event.
time_remainingstringThe estimated time remaining until the completion of this Event. This value is only returned for some in-progress migration events. For all other in-progress events, the percent_complete attribute will indicate about how much more work is to be done.
usernamestringThe username of the User who caused the Event.

Methods

NameAccessible byRequired ParamsDescription
getEventSELECTeventIdReturns a single Event object.
getEventsSELECTReturns a collection of Event objects representing actions taken on your Account from the last 90 days. The Events returned depend on your grants.
_getEventEXECeventIdReturns a single Event object.
_getEventsEXECReturns a collection of Event objects representing actions taken on your Account from the last 90 days. The Events returned depend on your grants.
eventReadEXECeventIdMarks a single Event as read.
eventSeenEXECeventIdMarks all Events up to and including this Event by ID as seen.