Events
This section details Event-related Linode CLI commands.
list
Aliases: ls
Returns a collection of Event objects representing actions taken on your Account from the last 90 days.
Usage
The format accepted by this command.
linode-cli events list [-h] [--read read] [--id id]
[--created created] [--entity.id entity.id]
[--entity.type entity.type] [--action action]
[--order-by {read,id,created,entity.id,entity.type,action}]
[--order {asc,desc}]
Sample
Examples of how this command might be used.
linode-cli events list
Filterable Attributes
Arguments used to define a filter for response entries.
Name |
Type |
Description |
|---|---|---|
--action |
str |
The action that caused this Event. |
--created |
str |
When this Event was created. |
--entity.id |
int |
The unique ID for an Event’s entity. |
--entity.type |
str |
The type of entity that is being referenced by the Event. |
--id |
int |
The unique ID of this Event. |
--read |
bool |
If this Event has been read. |
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
action |
str |
ticket_create |
The action that caused this Event. |
created |
str |
2018-01-01T00:01:01 |
When this Event was created. |
duration |
float |
300.56 |
The total duration in seconds that it takes for the Event to complete. |
id |
int |
123 |
The unique ID of this Event. |
message |
str |
None |
Provides additional information about the event. |
percent_complete |
int |
N/A |
A percentage estimating the amount of time remaining for an Event. |
rate |
str |
N/A |
The rate of completion of the Event. |
read |
bool |
true |
If this Event has been read. |
seen |
bool |
true |
If this Event has been seen. |
status |
str |
N/A |
The current status of this Event. |
time_remaining |
str |
N/A |
The estimated time remaining until the completion of this Event. |
username |
str |
exampleUser |
The username of the User who caused the Event. |
entity
Name |
Type |
Example |
Description |
|---|---|---|---|
entity.id |
int |
11111 |
The unique ID for an Event’s entity. |
entity.label |
str |
Problem booting my Linode |
The current label of this object. |
entity.type |
str |
ticket |
The type of entity that is being referenced by the Event. |
entity.url |
str |
/v4/support/tickets/11111 |
The URL where you can access the object this Event is for. |
secondary_entity
Name |
Type |
Example |
Description |
|---|---|---|---|
secondary_entity.id |
str |
linode/debian9 |
The ID of the object that is the secondary entity. |
secondary_entity.label |
str |
linode1234 |
The label of this object. |
secondary_entity.type |
str |
linode |
The type of entity that is being referenced by the Event. |
secondary_entity.url |
str |
/v4/linode/instances/1234 |
The URL where you can access the object this Event is for. |
view
Returns a single Event object.
Usage
The format accepted by this command.
linode-cli events view [-h] [--action action]
[--entity.type entity.type] [--entity.id entity.id]
[--created created] [--read read] [--id id]
[--order-by {action,entity.type,entity.id,created,read,id}]
[--order {asc,desc}] eventId
Sample
Examples of how this command might be used.
linode-cli events view 123
Parameters
Positional parameters used to define the resource this command should target.
Name |
Type |
Description |
|---|---|---|
eventId |
int |
The ID of the Event. |
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
action |
str |
ticket_create |
The action that caused this Event. |
created |
str |
2018-01-01T00:01:01 |
When this Event was created. |
duration |
float |
300.56 |
The total duration in seconds that it takes for the Event to complete. |
id |
int |
123 |
The unique ID of this Event. |
message |
str |
None |
Provides additional information about the event. |
percent_complete |
int |
N/A |
A percentage estimating the amount of time remaining for an Event. |
rate |
str |
N/A |
The rate of completion of the Event. |
read |
bool |
true |
If this Event has been read. |
seen |
bool |
true |
If this Event has been seen. |
status |
str |
N/A |
The current status of this Event. |
time_remaining |
str |
N/A |
The estimated time remaining until the completion of this Event. |
username |
str |
exampleUser |
The username of the User who caused the Event. |
entity
Name |
Type |
Example |
Description |
|---|---|---|---|
entity.id |
int |
11111 |
The unique ID for an Event’s entity. |
entity.label |
str |
Problem booting my Linode |
The current label of this object. |
entity.type |
str |
ticket |
The type of entity that is being referenced by the Event. |
entity.url |
str |
/v4/support/tickets/11111 |
The URL where you can access the object this Event is for. |
secondary_entity
Name |
Type |
Example |
Description |
|---|---|---|---|
secondary_entity.id |
str |
linode/debian9 |
The ID of the object that is the secondary entity. |
secondary_entity.label |
str |
linode1234 |
The label of this object. |
secondary_entity.type |
str |
linode |
The type of entity that is being referenced by the Event. |
secondary_entity.url |
str |
/v4/linode/instances/1234 |
The URL where you can access the object this Event is for. |
mark-read
Marks a single Event as read.
Usage
The format accepted by this command.
linode-cli events mark-read [-h] eventId
Sample
Examples of how this command might be used.
linode-cli events mark-read 123
Parameters
Positional parameters used to define the resource this command should target.
Name |
Type |
Description |
|---|---|---|
eventId |
int |
The ID of the Event to designate as read. |
mark-seen
Marks all Events up to and including this Event by ID as seen.
Usage
The format accepted by this command.
linode-cli events mark-seen [-h] eventId
Sample
Examples of how this command might be used.
linode-cli events mark-seen 123
Parameters
Positional parameters used to define the resource this command should target.
Name |
Type |
Description |
|---|---|---|
eventId |
int |
The ID of the Event to designate as seen. |