linode-cli-events

List the events on your account

$ linode-cli events list

$ linode-cli events view [event_id]

$ linode-cli events mark-read [event_id]

The linode-cli events functionality is accessed as a subcommand of the main linode-cli tool. Its common invocation patterns are:

linode-cli events list [--json | --text] [--no-headers] [--delimiter <DELIMITER>] [--page <PAGE>] [--pages <PAGES>] [--all] [--format <FORMAT>] [--no-defaults] [--no-auto-pagination] [--filter <FILTER>]

linode-cli events view <event_id> [--json | --text] [--no-headers] [--delimiter <DELIMITER>] [--format <FORMAT>] [--no-defaults]

linode-cli events acknowledge <event_id> [--json | --text] [--no-headers] [--delimiter <DELIMITER>] [--format <FORMAT>] [--no-defaults]

    The unique identifier (ID) of the specific event to view or acknowledge. Required for view and acknowledge actions.

--json
    Output the command's results in structured JSON format.

--text
    Output the command's results in a human-readable text table format. This is often the default.

--no-headers
    When using --text output, suppress the column headers.

--delimiter
    Specify a custom delimiter character for separating columns in --text output, useful for scripting.

--page
    For commands that return a list of resources (like list), specify a particular page number of results to retrieve.

--pages
    For commands that return a list, specify the maximum number of pages to retrieve. Can be used with --page.

--all
    Retrieve all available results for a list command, overriding pagination limits. This can be resource-intensive for large datasets.

--format
    Control the output columns and their order using a comma-separated list of field names (e.g., 'id,created,action'). Only applicable to --text output.

--no-defaults
    Do not use default values for omitted arguments. This forces you to provide all required arguments explicitly.

--no-auto-pagination
    Disable automatic pagination when retrieving lists of resources. You will need to explicitly manage pagination with --page and --pages.

--filter
    Apply a JSON filter string to narrow down the results returned by list commands based on specific criteria (e.g., '{"action":"linode_boot"}').

The linode-cli events subcommand allows users to interact with Linode account events directly from the command line. These events represent actions or changes occurring within your Linode account, such as Linode deployments, reboots, disk operations, or maintenance notifications. This functionality is crucial for monitoring account activity and staying informed about critical operations. Users can retrieve a list of all events, view details of a specific event, or acknowledge an event to mark it as handled, facilitating proactive management of your Linode infrastructure.

The linode-cli tool must be installed and properly configured with a valid Linode API token. The API token requires appropriate permissions: at least 'events:read_only' for listing and viewing events, and 'events:read_write' for acknowledging events.

The linode-cli events subcommand primarily supports three common actions:
• list: Retrieves a paginated list of all events associated with your Linode account.
• view <event_id>: Displays detailed information for a specific event identified by its ID.
• acknowledge <event_id>: Marks a specific event as acknowledged, indicating that it has been reviewed or handled. This action requires appropriate write permissions for events.

Proper API token permissions are crucial for interacting with events. To simply list or view events, your API token needs at least 'events:read_only' access. However, if you intend to acknowledge events, the API token must have 'events:read_write' permission for the events scope.

The linode-cli is developed and maintained by Linode (now Akamai Technologies) as the official command-line interface for their cloud services. The events subcommand has been a fundamental part of the CLI since its early versions, providing essential functionality for users to monitor system and account activities directly from their terminals. Its evolution parallels the development of the Linode API, ensuring consistency and access to new event types as they are introduced.

linode-cli(1), linode-cli account(1), linode-cli linodes(1), curl(1)