Account

Event View

get
https://api.linode.com/v4/account/events/{eventId}

Returns a single Event object.

Path Parameters

eventId
Required
integer

The ID of the Event.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
    https://api.linode.com/v4/account/events/123

Response Samples

{
  "status": "",
  "created": "2018-01-01T00:01:01",
  "id": 1234,
  "action": "ticket_create",
  "duration": 300.56,
  "entity": {
    "id": 11111,
    "label": "Problem booting my Linode",
    "type": "ticket",
    "url": "/v4/support/tickets/11111"
  },
  "secondary_entity": {
    "id": "linode/debian9",
    "label": "linode1234",
    "type": "linode",
    "url": "/v4/linode/instances/1234"
  },
  "percent_complete": "",
  "rate": "",
  "read": true,
  "seen": true,
  "time_remaining": "",
  "username": "exampleUser",
  "message": "None"
}

Responses

200: An Event object

status
string
Enum: "failed""finished""notification""scheduled""started"

The current status of this Event.

created
Filterable
string <date-time>

When this Event was created.

id
Filterable
integer

The unique ID of this Event.

action
Filterable
string
Enum: "account_update""account_settings_update""backups_enable""backups_cancel""backups_restore""community_question_reply""community_like""credit_card_updated""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_cancel""entity_transfer_create""entity_transfer_fail""entity_transfer_stale""firewall_create""firewall_delete""firewall_disable""firewall_enable""firewall_update""firewall_device_add""firewall_device_remove""host_reboot""image_delete""image_update""image_upload""ipaddress_update""lassie_reboot""lish_boot""linode_addip""linode_boot""linode_clone""linode_create""linode_delete""linode_update""linode_deleteip""linode_migrate""linode_migrate_datacenter""linode_migrate_datacenter_create""linode_mutate""linode_mutate_create""linode_reboot""linode_rebuild""linode_resize""linode_resize_create""linode_shutdown""linode_snapshot""linode_config_create""linode_config_delete""linode_config_update""lke_node_create""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""password_reset""payment_method_add""payment_submitted""profile_update""stackscript_create""stackscript_delete""stackscript_update""stackscript_publicize""stackscript_revise""tag_create""tag_delete""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"

The action that caused this Event. New actions may be added in the future.

duration
number

The total duration in seconds that it takes for the Event to complete.

entity
object

Detailed information about the Event's entity, including ID, type, label, and URL used to access it.

id
Filterable
integer

The unique ID for an Event's entity.

Some Event entities do not have IDs associated with them, so they will not be returned when filtering by ID. These Events include:

  • account
  • profile

Entities for some Events are assigned the ID of the Linode they correspond to. When filtering by ID for these Events, use the corresponding Linode's ID. These Events include:

  • disks
  • backups

Tag Events use a tag's name for the entity ID field. When filtering by ID for tag Events, supply the name of the tag.

label
string

The current label of this object. The label may reflect changes that occur with this Event.

type
Filterable
string
Enum: "account""backups""community""disks""domain""entity_transfer""firewall""image""ipaddress""linode""longview""managed_service""nodebalancer""oauth_client""profile""stackscript""tag""ticket""token""user""user_ssh_key""volume"

The type of entity that is being referenced by the Event.

url
string

The URL where you can access the object this Event is for. If a relative URL, it is relative to the domain you retrieved the Event from.

secondary_entity
object

Detailed 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.

id
string

The ID of the object that is the secondary entity.

label
string

The label of this object.

type
string

The type of entity that is being referenced by the Event.

url
string

The URL where you can access the object this Event is for. If a relative URL, it is relative to the domain you retrieved the Event from.

percent_complete
integer

A percentage estimating the amount of time remaining for an Event. Returns null for notification events.

rate
string

The rate of completion of the Event. Only some Events will return rate; for example, migration and resize Events.

read
Filterable
boolean

If this Event has been read.

seen
boolean

If this Event has been seen.

time_remaining
Nullable
string

The 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.

username
Nullable
string

The username of the User who caused the Event.

message
Nullable
string

Provides 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.

default: Error

errors
array of objects
reason
string

What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.

field
string

The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.