@akamai/openapi-ts
    Preparing search index...

    Type Alias AddedGetNotifications200Writable

    type AddedGetNotifications200Writable = {
        data?: {
            body?: string | null;
            entity?:
                | {
                    id?: number
                    | null;
                    label?: string | null;
                    type?:
                        | "account"
                        | "entity_transfer"
                        | "linode"
                        | "loadbalancers"
                        | "nodebalancer"
                        | "promotion"
                        | "region"
                        | "ticket"
                        | "volume";
                    url?: string
                    | null;
                }
                | null;
            label?: string;
            message?: string;
            severity?: "minor"
            | "major"
            | "critical";
            type?:
                | "migration_scheduled"
                | "migration_imminent"
                | "migration_pending"
                | "reboot_scheduled"
                | "outage"
                | "payment_due"
                | "ticket_important"
                | "ticket_abuse"
                | "notice"
                | "maintenance"
                | "maintenance_scheduled"
                | "promotion"
                | "security_reboot_maintenance_scheduled"
                | "tax_id_verifying";
            until?: string
            | null;
            when?: string | null;
        }[];
    }
    Index

    Properties

    data?

    Properties

    data?: {
        body?: string | null;
        entity?:
            | {
                id?: number
                | null;
                label?: string | null;
                type?:
                    | "account"
                    | "entity_transfer"
                    | "linode"
                    | "loadbalancers"
                    | "nodebalancer"
                    | "promotion"
                    | "region"
                    | "ticket"
                    | "volume";
                url?: string
                | null;
            }
            | null;
        label?: string;
        message?: string;
        severity?: "minor"
        | "major"
        | "critical";
        type?:
            | "migration_scheduled"
            | "migration_imminent"
            | "migration_pending"
            | "reboot_scheduled"
            | "outage"
            | "payment_due"
            | "ticket_important"
            | "ticket_abuse"
            | "notice"
            | "maintenance"
            | "maintenance_scheduled"
            | "promotion"
            | "security_reboot_maintenance_scheduled"
            | "tax_id_verifying";
        until?: string
        | null;
        when?: string | null;
    }[]

    Type Declaration

    • Optionalbody?: string | null

      A full description of this notification, in markdown format. Not all notifications include a body. Returned as null for an event type of security_reboot_maintenance_scheduled.

    • Optionalentity?:
          | {
              id?: number
              | null;
              label?: string | null;
              type?:
                  | "account"
                  | "entity_transfer"
                  | "linode"
                  | "loadbalancers"
                  | "nodebalancer"
                  | "promotion"
                  | "region"
                  | "ticket"
                  | "volume";
              url?: string
              | null;
          }
          | null

      Detailed information about the notification. Returned as null for an event type of security_reboot_maintenance_scheduled.

    • Optionallabel?: string

      A short description of this notification.

    • Optionalmessage?: string

      A human-readable description of the notification.

    • Optionalseverity?: "minor" | "major" | "critical"

      The severity of this notification. This field determines how prominently the notification is displayed and the color of the display text.

    • Optionaltype?:
          | "migration_scheduled"
          | "migration_imminent"
          | "migration_pending"
          | "reboot_scheduled"
          | "outage"
          | "payment_due"
          | "ticket_important"
          | "ticket_abuse"
          | "notice"
          | "maintenance"
          | "maintenance_scheduled"
          | "promotion"
          | "security_reboot_maintenance_scheduled"
          | "tax_id_verifying"

      Filterable The type of notification.

      📘

      A security_reboot_maintenance_scheduled event is a global notice that a Linode needs to be rebooted for QEMU upgrade maintenance. Have a look at this workflow for guidance on reboooting your Linodes for this maintenance.

    • Optionaluntil?: string | null

      If this notification has a duration, this is when the event or action will complete. For example, if there's scheduled maintenance for one of our systems, until represents the end of the maintenance window. Returned as null for an event type of security_reboot_maintenance_scheduled.

    • Optionalwhen?: string | null

      If this notification is for an event in the future, this specifies when the action occurs. For example, if a compute instance needs to migrate in response to a security advisory, this field sets the approximate time the compute instance will be taken offline for migration. Returned as null for an event type of security_reboot_maintenance_scheduled.

    Settings

    Member Visibility

    On This Page

    Properties