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

    Type Alias PutLinodeInstanceResponses

    type PutLinodeInstanceResponses = {
        "200": {
            alerts: {
                cpu: number;
                io: number;
                network_in: number;
                network_out: number;
                transfer_quota: number;
            };
            backups: {
                available: boolean;
                enabled: boolean;
                last_successful: string;
                schedule: {
                    day: | "Scheduling"
                    | "Sunday"
                    | "Monday"
                    | "Tuesday"
                    | "Wednesday"
                    | "Thursday"
                    | "Friday"
                    | "Saturday";
                    window: | "Scheduling"
                    | "W0"
                    | "W2"
                    | "W4"
                    | "W6"
                    | "W8"
                    | "W10"
                    | "W12"
                    | "W14"
                    | "W16"
                    | "W18"
                    | "W20"
                    | "W22";
                };
            };
            capabilities: string[];
            created: string;
            disk_encryption: string
            | null;
            group: string;
            has_user_data: boolean;
            host_uuid: string;
            hypervisor: "kvm";
            id: number;
            image: string | null;
            interface_generation: "legacy_config" | "linode";
            ipv4: string[];
            ipv6: string | null;
            label: string;
            lke_cluster_id: number | null;
            maintenance_policy: "linode/migrate" | "linode/power_off_on";
            placement_group:
                | {
                    id: number;
                    label: string;
                    placement_group_policy: "strict"
                    | "flexible";
                    placement_group_type: "anti_affinity:local";
                }
                | null;
            region: string;
            specs: {
                disk: number;
                gpus: number;
                memory: number;
                transfer: number;
                vcpus: number;
            };
            status: | "running"
            | "offline"
            | "booting"
            | "busy"
            | "rebooting"
            | "shutting_down"
            | "provisioning"
            | "deleting"
            | "migrating"
            | "rebuilding"
            | "cloning"
            | "restoring"
            | "stopped"
            | "billing_suspension";
            tags: string[];
            type: string;
            updated: string;
            watchdog_enabled: boolean;
        };
    }
    Index

    Properties

    200

    Properties

    "200": {
        alerts: {
            cpu: number;
            io: number;
            network_in: number;
            network_out: number;
            transfer_quota: number;
        };
        backups: {
            available: boolean;
            enabled: boolean;
            last_successful: string;
            schedule: {
                day: | "Scheduling"
                | "Sunday"
                | "Monday"
                | "Tuesday"
                | "Wednesday"
                | "Thursday"
                | "Friday"
                | "Saturday";
                window: | "Scheduling"
                | "W0"
                | "W2"
                | "W4"
                | "W6"
                | "W8"
                | "W10"
                | "W12"
                | "W14"
                | "W16"
                | "W18"
                | "W20"
                | "W22";
            };
        };
        capabilities: string[];
        created: string;
        disk_encryption: string
        | null;
        group: string;
        has_user_data: boolean;
        host_uuid: string;
        hypervisor: "kvm";
        id: number;
        image: string | null;
        interface_generation: "legacy_config" | "linode";
        ipv4: string[];
        ipv6: string | null;
        label: string;
        lke_cluster_id: number | null;
        maintenance_policy: "linode/migrate" | "linode/power_off_on";
        placement_group:
            | {
                id: number;
                label: string;
                placement_group_policy: "strict"
                | "flexible";
                placement_group_type: "anti_affinity:local";
            }
            | null;
        region: string;
        specs: {
            disk: number;
            gpus: number;
            memory: number;
            transfer: number;
            vcpus: number;
        };
        status: | "running"
        | "offline"
        | "booting"
        | "busy"
        | "rebooting"
        | "shutting_down"
        | "provisioning"
        | "deleting"
        | "migrating"
        | "rebuilding"
        | "cloning"
        | "restoring"
        | "stopped"
        | "billing_suspension";
        tags: string[];
        type: string;
        updated: string;
        watchdog_enabled: boolean;
    }

    Linode

    The updated Linode.

    Type Declaration

    • alerts: {
          cpu: number;
          io: number;
          network_in: number;
          network_out: number;
          transfer_quota: number;
      }
      • cpu: number

        The percentage of CPU usage required to trigger an alert. If the average CPU usage over two hours exceeds this value, we'll send you an alert. Your Linode's total CPU capacity is represented as 100%, multiplied by its number of cores.

        For example, a two core Linode's CPU capacity is represented as 200%. If you want to be alerted at 90% of a two core Linode's CPU capacity, set the alert value to 180.

        The default value is 90% multiplied by the number of cores.

        If the value is set to 0 (zero), the alert is disabled.

      • io: number

        The amount of disk IO operation per second required to trigger an alert. If the average disk IO over two hours exceeds this value, we'll send you an alert. If set to 0 (zero), this alert is disabled.

      • network_in: number

        The amount of incoming traffic, in Mbit/s, required to trigger an alert. If the average incoming traffic over two hours exceeds this value, we'll send you an alert. If this is set to 0 (zero), the alert is disabled.

      • network_out: number

        The amount of outbound traffic, in Mbit/s, required to trigger an alert. If the average outbound traffic over two hours exceeds this value, we'll send you an alert. If this is set to 0 (zero), the alert is disabled.

      • transfer_quota: number

        The percentage of network transfer that may be used before an alert is triggered. When this value is exceeded, we'll alert you. If this is set to 0 (zero), the alert is disabled.

    • backups: {
          available: boolean;
          enabled: boolean;
          last_successful: string;
          schedule: {
              day:
                  | "Scheduling"
                  | "Sunday"
                  | "Monday"
                  | "Tuesday"
                  | "Wednesday"
                  | "Thursday"
                  | "Friday"
                  | "Saturday";
              window: | "Scheduling"
              | "W0"
              | "W2"
              | "W4"
              | "W6"
              | "W8"
              | "W10"
              | "W12"
              | "W14"
              | "W16"
              | "W18"
              | "W20"
              | "W22";
          };
      }

      Information about this Linode's backups status. For information about available backups, run List backups.

      • Readonlyavailable: boolean

        Read-only Whether Backups for this Linode are available for restoration.

        Backups undergoing maintenance are not available for restoration.

      • Readonlyenabled: boolean

        Read-only If this Linode has the Backup service enabled. To enable backups, run Enable backups.

      • Readonlylast_successful: string

        Read-only The last successful backup time. Displayed as null if there was no previous backup.

      • schedule: {
            day:
                | "Scheduling"
                | "Sunday"
                | "Monday"
                | "Tuesday"
                | "Wednesday"
                | "Thursday"
                | "Friday"
                | "Saturday";
            window: | "Scheduling"
            | "W0"
            | "W2"
            | "W4"
            | "W6"
            | "W8"
            | "W10"
            | "W12"
            | "W14"
            | "W16"
            | "W18"
            | "W20"
            | "W22";
        }
        • day:
              | "Scheduling"
              | "Sunday"
              | "Monday"
              | "Tuesday"
              | "Wednesday"
              | "Thursday"
              | "Friday"
              | "Saturday"

          The day of the week that your Linode's weekly backup is taken. If not set manually, a day will be chosen for you. Backups are taken every day, but backups taken on this day are preferred when selecting backups to retain for a longer period.

          If not set manually, then when backups are initially enabled, this may come back as Scheduling until the day is automatically selected.

        • window:
              | "Scheduling"
              | "W0"
              | "W2"
              | "W4"
              | "W6"
              | "W8"
              | "W10"
              | "W12"
              | "W14"
              | "W16"
              | "W18"
              | "W20"
              | "W22"

          When your backups will be taken, in UTC. A backups window is a two-hour span of time in which the backup may occur.

          For example, W10 indicates that your backups should be taken between 10:00 and 12:00. If you don't choose a backup window, the API automatically assigns one.

          If not set manually, when backups are initially enabled this may come back as Scheduling until the window is automatically selected.

    • Readonlycapabilities: string[]

      Limited availability, Read-only A list of capabilities this compute instance supports.

    • Readonlycreated: string

      Read-only When this Linode was created.

    • Readonlydisk_encryption: string | null

      Read-only Indicates the local disk encryption setting for this Linode. If the Linode is part of an LKE cluster, the value is null.

    • group: string

      Deprecated, Filterable The group label for this Linode.

    • Readonlyhas_user_data: boolean

      Read-only Whether this compute instance was provisioned with user_data provided via the Metadata service. See the Create a Linode description for more information on Metadata.

    • Readonlyhost_uuid: string

      Read-only The Linode's host machine, as a UUID.

    • hypervisor: "kvm"

      Read-only The virtualization software powering this Linode.

    • Readonlyid: number

      Filterable, Read-only This Linode's ID which must be provided for all operations impacting this Linode.

    • image: string | null

      An Image ID to deploy the Linode Disk from.

      Run the List images operation with authentication to view all available Images. Official Linode Images start with linode/, while your Account's Images start with private/. Creating a disk from a Private Image requires read_only or read_write permissions for that Image. Run the Update a user's grants operation to adjust permissions for an Account Image.

    • interface_generation: "legacy_config" | "linode"

      Filterable, Read-only Indicates if the Linode is configured to use Linode interfaces (linode) or legacy configuration profile interfaces (legacy_config).

    • Readonlyipv4: string[]

      Filterable, Read-only This Linode's IPv4 Addresses. Each Linode is assigned a single public IPv4 address upon creation, and may get a single private IPv4 address if needed. You may need to Open a support ticket to get additional IPv4 addresses.

      IPv4 addresses may be reassigned between your Linodes, or shared with other Linodes. See the networking operations for details.

    • Readonlyipv6: string | null

      Read-only This Linode's IPv6 SLAAC address. This address is specific to a Linode, and may not be shared. If the Linode has not been assigned an IPv6 address, the return value will be null.

    • label: string

      Filterable Provides a name for the Linode. If not provided, the API generates one for it.

      Linode labels have the following constraints:

      • It needs to begin and end with an alphanumeric character.
      • It can only consist of alphanumeric characters, hyphens (-), underscores (_) or periods (.).
      • Cannot have two hyphens (--), underscores (__) or periods (..) in a row.
    • Readonlylke_cluster_id: number | null

      Read-only The ID of the Kubernetes cluster if the Linode is part of cluster.

    • maintenance_policy: "linode/migrate" | "linode/power_off_on"

      Beta The maintenance policy configured by the user for this Linode. Review maintenance policy documentation for more details.

    • Readonlyplacement_group:
          | {
              id: number;
              label: string;
              placement_group_policy: "strict"
              | "flexible";
              placement_group_type: "anti_affinity:local";
          }
          | null

      Read-only Details on the placement group that this Linode belongs to. Empty if the Linode isn't in a placement group.

    • Readonlyregion: string

      Filterable, Read-only The region where the Linode deployed. A Linode's region can only be changed by initiating a cross data center migration.

    • Readonlyspecs: { disk: number; gpus: number; memory: number; transfer: number; vcpus: number }

      Read-only Information about the resources available to this Linode.

      • Readonlydisk: number

        Read-only The amount of storage space, in MB, this Linode has access to. A typical Linode divides this space between a primary disk with an image deployed to it, and a swap disk, usually 512 MB. This is the default configuration created when deploying a Linode with an image through Create a Linode. While this configuration is suitable for 99% of use cases, if you need finer control over your Linode's disks, see the List disks operations.

      • Readonlygpus: number

        Read-only The number of GPUs this Linode has access to.

      • Readonlymemory: number

        Read-only The amount of RAM, in MB, this Linode has access to.

        Typically, a Linode boots with all of its available RAM, but this can be configured in a config profile. See the List config profiles operation for more information.

      • Readonlytransfer: number

        Read-only The amount of network transfer this Linode is allotted each month.

      • Readonlyvcpus: number

        Read-only The number of VCPUs this Linode has access to.

    • status:
          | "running"
          | "offline"
          | "booting"
          | "busy"
          | "rebooting"
          | "shutting_down"
          | "provisioning"
          | "deleting"
          | "migrating"
          | "rebuilding"
          | "cloning"
          | "restoring"
          | "stopped"
          | "billing_suspension"

      Read-only A brief description of this Linode's current state. This field may change without direct action from you. For example, when a compute instance goes into maintenance mode, its status is stopped. Status is generally self-explanatory, based on its name.

      • busy indicates you've assigned the compute instance to a placement group, but the compute instance is currently booting. Once the boot completes, the API completes the assignment and updates the compute instance's status accordingly.
      • provisioning indicates that the API is applying operating system or Marketplace applications on the compute instance.
      • billing_suspension indicates that payment is past due on the compute instance, so we've suspended its use.
    • tags: string[]

      Filterable Tags to help you organize your content.

    • Readonlytype: string

      Read-only This is the Linode type that this Linode was deployed with. To change a Linode's type, use Resize a Linode.

    • Readonlyupdated: string

      Read-only When this Linode was last updated.

    • watchdog_enabled: boolean

      The watchdog, named Lassie, is a Shutdown Watchdog that monitors your Linode and reboots it if it powers off unexpectedly. It works by issuing a boot job when your Linode powers off without a shutdown job being responsible. To prevent a loop, Lassie gives up if there have been more than 5 boot jobs issued within 15 minutes.

    Settings

    Member Visibility

    On This Page

    Properties