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

    Type Alias PostMigrateLinodeInstanceData

    type PostMigrateLinodeInstanceData = {
        body?: {
            placement_group?: { id: number };
            region?: string;
            type?: "warm" | "cold";
            upgrade?: boolean;
        };
        path: { linodeId: number };
        query?: never;
        url: "linode/instances/{linodeId}/migrate";
    }
    Index

    Properties

    body? path query? url

    Properties

    Optionalbody

    body?: {
        placement_group?: { id: number };
        region?: string;
        type?: "warm" | "cold";
        upgrade?: boolean;
    }

    Type Declaration

    • Optionalplacement_group?: { id: number }

      Include this to assign this Linode to an existing placement group in the data center you're migrating to. These constraints apply:

      • If the target Linode is in a placement group, it will be removed from it when migrating.
      • The target placement group needs to be in the same region you're migrating to.
      • The placement group needs to have capacity. Run the Get a region operation and note either the maximum_linodes_per_pg (strict) or maximum_linodes_per_flexible_pg (flexible), based on your selected placement_group_policy. These represent the Linode limit per placement group, for each placement_group_policy type. You can then run the Get a placement group operation to review the Linodes in that group.
      • id: number

        The placement group's ID. You need to provide it for all operations that affect it.

    • Optionalregion?: string

      The region to which the Linode will be migrated. Must be a valid region slug. A list of regions can be viewed by running the List regions operation. A cross data center migration will cancel a pending migration that has not yet been initiated. A cross data center migration will initiate a linode_migrate_datacenter_create event.

    • Optionaltype?: "warm" | "cold"

      Type of migration used in moving to a new host or Linode type.

      warm: the Linode will not power down until the migration is complete. Warm migrations are not available for DC migrations.

      cold: the Linode will be powered down and migrated. When the migration is complete, the Linode will be powered on.

    • Optionalupgrade?: boolean

      When initiating a cross DC migration, setting this value to true will also ensure that the Linode is upgraded to the latest generation of hardware that corresponds to your Linode's Type, if any free upgrades are available for it. If no free upgrades are available, and this value is set to true, then the endpoint will return a 400 error code and the migration will not be performed. If the data center set in the region field does not allow upgrades, then the endpoint will return a 400 error code and the migration will not be performed.

    path: { linodeId: number }

    Type Declaration

    • linodeId: number

      ID of the Linode to migrate.

    query?: never
    url: "linode/instances/{linodeId}/migrate"

    Settings

    Member Visibility

    On This Page

    Properties