Events List

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "A collection of Event objects. An Event is an action taken against an entity related to your Account. For example, booting a Linode would create an Event.\nThe Events returned depends on your grants.\n",
        "properties": {
          "action": {
            "type": "string",
            "description": "The action that caused this Event. New actions may be added in the future.\n",
            "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"
            ]
          },
          "created": {
            "type": "string",
            "format": "date-time",
            "description": "When this Event was created."
          },
          "duration": {
            "type": "number",
            "description": "The total duration in seconds that it takes for the Event to complete.\n"
          },
          "entity": {
            "type": "object",
            "description": "Detailed information about the Event's entity, including ID, type, label, and URL used to access it.\n",
            "properties": {
              "id": {
                "type": "integer",
                "description": "The unique ID for an Event's entity.\n\n\nSome Event entities do not have IDs associated with them, so they\nwill not be returned when filtering by ID. These Events include:\n  * `account`\n  * `profile`\n\nEntities for some Events are assigned the ID of the Linode they correspond to.\nWhen filtering by ID for these Events, use the corresponding Linode's ID.\nThese Events include:\n  * `disks`\n  * `backups`\n\n\nTag Events use a tag's name for the entity ID field. When filtering by ID\nfor tag Events, supply the name of the tag.\n"
              },
              "label": {
                "type": "string",
                "description": "The current label of this object. The label may reflect changes that occur with this Event.\n"
              },
              "type": {
                "type": "string",
                "description": "The type of entity that is being referenced by the Event.\n",
                "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"
                ]
              },
              "url": {
                "type": "string",
                "description": "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.\n"
              }
            }
          },
          "id": {
            "type": "integer",
            "description": "The unique ID of this Event."
          },
          "message": {
            "type": "string",
            "description": "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.\n"
          },
          "percent_complete": {
            "type": "integer",
            "description": "A percentage estimating the amount of time remaining for an Event.\nReturns `null` for notification events.\n"
          },
          "rate": {
            "type": "string",
            "description": "The rate of completion of the Event. Only some Events will return rate; for example, migration and resize Events.\n"
          },
          "read": {
            "type": "boolean",
            "description": "If this Event has been read."
          },
          "secondary_entity": {
            "type": "object",
            "description": "Detailed information about the Event's secondary entity, which provides additional information\nfor events such as, but not limited to, `linode_boot`, `linode_reboot`, `linode_create`, and `linode_clone` Event actions.\n",
            "properties": {
              "id": {
                "type": "string",
                "description": "The ID of the object that is the secondary entity.\n"
              },
              "label": {
                "type": "string",
                "description": "The label of this object.\n"
              },
              "type": {
                "type": "string",
                "description": "The type of entity that is being referenced by the Event.\n"
              },
              "url": {
                "type": "string",
                "description": "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.\n"
              }
            }
          },
          "seen": {
            "type": "boolean",
            "description": "If this Event has been seen."
          },
          "status": {
            "type": "string",
            "description": "The current status of this Event.",
            "enum": [
              "failed",
              "finished",
              "notification",
              "scheduled",
              "started"
            ]
          },
          "time_remaining": {
            "type": "string",
            "description": "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.\n"
          },
          "username": {
            "type": "string",
            "description": "The username of the User who caused the Event.\n"
          }
        }
      }
    },
    "page": {
      "type": "integer",
      "description": "The current [page](/docs/api/#pagination)."
    },
    "pages": {
      "type": "integer",
      "description": "The total number of [pages](/docs/api/#pagination)."
    },
    "results": {
      "type": "integer",
      "description": "The total number of results."
    }
  }
}