Skip to main content

events

Creates, updates, deletes, gets or lists an events resource.

Overview

Nameevents
TypeResource
Idlinode.account.events

Fields

The following fields are returned by SELECT queries:

An Event object.

NameDatatypeDescription
idintegerRead-only The unique ID of this event.
actionstringRead-only The action that caused this event. New actions may be added in the future. (account_agreement_eu_model, account_promo_apply, account_update, account_settings_update, backups_enable, backups_cancel, backups_restore, community_question_reply, community_like, community_mention, credit_card_updated, database_create, database_delete, database_update, database_failed, database_degraded, database_create_failed, database_update_failed, database_backup_create, database_backup_restore, database_backup_delete, database_credentials_reset, database_low_disk_space, database_scale, database_resize, database_resize_create, database_migrate, database_upgrade, database_suspend, database_resume, disk_create, disk_delete, disk_update, disk_duplicate, disk_imagize, disk_resize, dns_record_create, dns_record_delete, dns_record_update, dns_zone_create, dns_zone_delete, dns_zone_import, dns_zone_update, entity_transfer_accept, entity_transfer_accept_recipient, entity_transfer_cancel, entity_transfer_create, entity_transfer_fail, entity_transfer_stale, firewall_apply, firewall_create, firewall_delete, firewall_disable, firewall_enable, firewall_update, firewall_device_add, firewall_device_remove, firewall_rules_update, host_reboot, image_delete, image_update, image_upload, interface_create, interface_delete, interface_update, ipaddress_update, ipv6pool_add, ipv6pool_delete, lassie_reboot, lish_boot, linode_addip, linode_boot, linode_clone, linode_create, linode_delete, linode_update, linode_deleteip, linode_kvmify, linode_migrate, linode_migrate_datacenter, linode_migrate_datacenter_create, linode_mutate, linode_mutate_create, linode_poweroff_on, linode_reboot, linode_rebuild, linode_resize, linode_resize_create, linode_resize_warm_create, linode_shutdown, linode_snapshot, linode_config_create, linode_config_delete, linode_config_update, lke_control_plane_acl_create, lke_control_plane_acl_update, lke_control_plane_acl_delete, lke_cluster_create, lke_cluster_update, lke_cluster_delete, lke_cluster_recycle, lke_cluster_regenerate, lke_node_create, lke_node_delete, lke_node_recycle, lke_pool_create, lke_pool_delete, lke_pool_recycle, lke_kubeconfig_regenerate, lke_token_rotate, longviewclient_create, longviewclient_delete, longviewclient_update, managed_disabled, managed_enabled, managed_service_create, managed_service_delete, nodebalancer_create, nodebalancer_delete, nodebalancer_update, nodebalancer_config_create, nodebalancer_config_delete, nodebalancer_config_update, nodebalancer_node_create, nodebalancer_node_delete, nodebalancer_node_update, oauth_client_create, oauth_client_delete, oauth_client_secret_reset, oauth_client_update, obj_access_key_create, obj_access_key_delete, obj_access_key_update, password_reset, payment_method_add, payment_submitted, placement_group_assign, placement_group_became_compliant, placement_group_became_non_compliant, placement_group_create, placement_group_delete, placement_group_unassign, placement_group_update, profile_update, stackscript_create, stackscript_delete, stackscript_update, stackscript_publicize, stackscript_revise, subnet_create, subnet_delete, subnet_update, tag_create, tag_delete, tag_update, tax_id_valid, tax_id_invalid, tfa_disabled, tfa_enabled, ticket_attachment_upload, ticket_create, ticket_update, token_create, token_delete, token_update, user_create, user_update, user_delete, user_ssh_key_add, user_ssh_key_delete, user_ssh_key_update, vlan_attach, vlan_detach, volume_attach, volume_clone, volume_create, volume_delete, volume_update, volume_detach, volume_resize, volume_migrate, volume_migrate_scheduled, vpc_create, vpc_delete, vpc_update) (example: ticket_create)
createdstring (date-time)Read-only When the system created this event. (example: 2018-01-01T00:01:01)
detailsobjectBeta, Read-only Maintenance details for this event, if any.
durationnumberRead-only The number of seconds that it takes for the event to complete.
entityobjectRead-only Detailed information about the entity that triggered this event.
messagestringAdditional 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_completeintegerRead-only A percentage estimating the amount of time remaining for an event. Returned as null for notification events.
ratestringRead-only The rate of completion of the event. Only some events return a rate, such as the migration and resize events.
secondary_entityobjectRead-only Detailed information about the event's secondary entity, if applicable.
seenbooleanRead-only If a user on your account has marked an event as seen.
statusstringRead-only The current status of this event. (failed, finished, notification, scheduled, started)
time_remainingstringRead-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.
usernamestringRead-only The name of the user whose action caused the event. (example: exampleUser)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselecteventIdReturns a single event object.

Learn more...

Learn more...
listselectX-Filter, page, page_sizeReturns 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...
mark_seenexeceventIdAcknowledge 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.

NameDatatypeDescription
eventIdstringThe ID of the Event to designate as seen.
X-FilterSpecifies a JSON object to filter down the results. See Filtering and sorting for details. (example: {{X-Filter}})
pageintegerThe page of a collection to return.
page_sizeintegerThe number of items to return per page.

SELECT examples

Returns a single event object.

Learn more...

Learn more...

SELECT
id,
action,
created,
details,
duration,
entity,
message,
percent_complete,
rate,
secondary_entity,
seen,
status,
time_remaining,
username
FROM linode.account.events
WHERE eventId = '{{ eventId }}' -- required
;

Lifecycle Methods

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.mark_seen
@eventId='{{ eventId }}' --required
;