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

    Type Alias PostCloneLinodeInstanceData

    type PostCloneLinodeInstanceData = {
        body: {
            backups_enabled?: boolean;
            configs?: number[];
            disks?: number[];
            group?: string;
            label?: string;
            linode_id?: number;
            maintenance_policy?: "linode/migrate" | "linode/power_off_on";
            metadata?: { user_data?: string };
            placement_group?: { id: number };
            private_ip?: boolean;
            region?: string;
            type?: string;
        };
        path: { linodeId: number };
        query?: never;
        url: "linode/instances/{linodeId}/clone";
    }
    Index

    Properties

    body path query? url

    Properties

    body

    body: {
        backups_enabled?: boolean;
        configs?: number[];
        disks?: number[];
        group?: string;
        label?: string;
        linode_id?: number;
        maintenance_policy?: "linode/migrate" | "linode/power_off_on";
        metadata?: { user_data?: string };
        placement_group?: { id: number };
        private_ip?: boolean;
        region?: string;
        type?: string;
    }

    The requested state your Linode will be cloned into.

    Type Declaration

    • Optionalbackups_enabled?: boolean

      If this field is set to true, the created Linode will automatically be enrolled in the Linode Backup service. This will incur an additional charge. Pricing is included in the response from List types.

      • Can only be included when cloning to a new Linode.
    • Optionalconfigs?: number[]

      An array of configuration profile IDs.

      • If the configs parameter is not provided, then all configuration profiles and their associated disks will be cloned from the source Linode. Any disks specified by the disks parameter will also be cloned.
      • If an empty array is provided for the configs parameter, then no configuration profiles (nor their associated disks) will be cloned from the source Linode. Any disks specified by the disks parameter will still be cloned.
      • If a non-empty array is provided for the configs parameter, then the configuration profiles specified in the array (and their associated disks) will be cloned from the source Linode. Any disks specified by the disks parameter will also be cloned.
    • Optionaldisks?: number[]

      An array of disk IDs.

      • If the disks parameter is not provided, then no extra disks will be cloned from the source Linode. All disks associated with the configuration profiles specified by the configs parameter will still be cloned.
      • If an empty array is provided for the disks parameter, then no extra disks will be cloned from the source Linode. All disks associated with the configuration profiles specified by the configs parameter will still be cloned.
      • If a non-empty array is provided for the disks parameter, then the disks specified in the array will be cloned from the source Linode, in addition to any disks associated with the configuration profiles specified by the configs parameter.
    • Optionalgroup?: string

      A label used to group Linodes for display. Linodes are not required to have a group.

    • Optionallabel?: string

      The label to assign this Linode when cloning to a new Linode.

      • Can only be provided when cloning to a new Linode.
      • Defaults to linode.
    • Optionallinode_id?: number

      If an existing Linode is the target for the clone, the ID of that Linode. The existing Linode must have enough resources to accept the clone.

    • Optionalmaintenance_policy?: "linode/migrate" | "linode/power_off_on"

      Beta Defines the maintenance policy for the new Linode. If you don't provide it, the new Linode inherits the maintenance policy from the original Linode. Review maintenance policy documentation for more details.

    • Optionalmetadata?: { user_data?: string }

      Write-only An object containing user-defined data relevant to the creation of Linodes.

      • Optionaluser_data?: string

        Base64-encoded cloud-config data.

        Cannot be modified after provisioning. To update, use either the Clone a Linode or Rebuild a Linode operations.

        Must not be included when cloning to an existing Linode.

        Unencoded data must not exceed 65535 bytes, or about 16kb encoded.

    • Optionalplacement_group?: { id: number }

      Include this to assign this Linode to an existing placement group. Consider these points when cloning:

      • If the Linode you're cloning exists in a placement group, the API won't automatically add the cloned instance to the same placement group. You need to specify a placement group to add the clone to.

      • The target placement group needs to be in the same region set for this Linode.

      • 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.

    • Optionalprivate_ip?: boolean

      If true, the created Linode will have private networking enabled and assigned a private IPv4 address.

      • Can only be provided when cloning to a new Linode.
    • Optionalregion?: string

      This is the Region where the Linode will be deployed. To view all available Regions you can deploy to, run List regions.

      • Region can only be provided and is required when cloning to a new Linode.
    • Optionaltype?: string

      A Linode's Type determines what resources are available to it, including disk space, memory, and virtual cpus. The amounts available to a specific Linode are returned as specs on the Linode object.

      To view all available Linode Types you can deploy with, run List types.

      • Type can only be provided and is required when cloning to a new Linode.
    path: { linodeId: number }

    Type Declaration

    • linodeId: number

      ID of the Linode to clone.

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

    Settings

    Member Visibility

    On This Page

    Properties