events
Creates, updates, deletes, gets or lists an events resource.
Overview
| Name | events |
| Type | Resource |
| Id | linode.account.events |
Fields
The following fields are returned by SELECT queries:
- get_event
- get_events
An Event object.
| Name | Datatype | Description |
|---|---|---|
id | integer | Read-only The unique ID of this event. |
action | string | Read-only The action that caused this event. New actions may be added in the future. (example: ticket_create) |
created | string (date-time) | Read-only When the system created this event. (example: 2018-01-01T00:01:01) |
duration | number | Read-only The number of seconds that it takes for the event to complete. |
entity | object | Read-only Detailed information about the entity that triggered this event. |
message | string | Additional information about the event. This can be a more detailed representation of an event that can help you diagnose non-obvious failures. (example: None) |
percent_complete | integer | Read-only A percentage estimating the amount of time remaining for an event. Returned as null for notification events. |
rate | string | Read-only The rate of completion of the event. Only some events return a rate, such as the migration and resize events. |
read | boolean | Read-only If a user on your account has marked an event as read. |
secondary_entity | object | Read-only Detailed information about the event's secondary entity, if applicable. |
seen | boolean | Read-only If a user on your account has marked an event as seen. |
status | string | Read-only The current status of this event. |
time_remaining | string | Read-only The estimated time remaining until the event completes. This is only returned for some in-progress migration events. Otherwise, percent_complete indicates how long until completion. |
username | string | Read-only The name of the user whose action caused the event. (example: exampleUser) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_event | select | Returns a single event object. Learn more... Learn more... | ||
get_events | select | page, page_size | Returns a collection of event objects that represent actions you've taken on your account, over the last 90 days. The events returned depend on your user grants. Learn more... Learn more... | |
post_event_seen | exec | Acknowledge an event by marking it as seen. > 📘 > > On June 17, 2025, the "Mark an event as read" operation was sunset. Attempts to call it will return a 404. Use this operation instead. Learn more... Learn more... |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
page | integer | The page of a collection to return. |
page_size | integer | The number of items to return per page. |
SELECT examples
- get_event
- get_events
Returns a single event object.
Learn more...
Learn more...
SELECT
id,
action,
created,
duration,
entity,
message,
percent_complete,
rate,
read,
secondary_entity,
seen,
status,
time_remaining,
username
FROM linode.account.events;
Returns a collection of event objects that represent actions you've taken on your account, over the last 90 days. The events returned depend on your user grants.
Learn more...
Learn more...
SELECT
data,
page,
pages,
results
FROM linode.account.events
WHERE page = '{{ page }}'
AND page_size = '{{ page_size }}';
Lifecycle Methods
- post_event_seen
Acknowledge an event by marking it as seen.
> 📘
>
> On June 17, 2025, the "Mark an event as read" operation was sunset. Attempts to call it will return a 404. Use this operation instead.
Learn more...
Learn more...
EXEC linode.account.events.post_event_seen
;