Type Alias PostRebuildLinodeInstanceData

Type Declaration

• Optionalauthorized_keys?: string[]

  Write-only A list of public SSH keys that will be automatically appended to the root user's ~/.ssh/authorized_keys file when deploying from an Image.

• Optionalauthorized_users?: string[]

  Write-only A list of usernames for authorized users. Before you can add a user, it needs an SSH key assigned to its profile. See Add an SSH key for more information. If the usernames already have associated SSH keys, the keys will be appended to the root users ~/.ssh/authorized_keys file automatically when deploying from an image.

• Optionalbooted?: boolean

  Write-only This field defaults to true if the Linode is created with an Image or from a Backup. If it is deployed from an Image or a Backup and you wish it to remain offline after deployment, set this to false.

• Optionaldisk_encryption?: "enabled" | "disabled"

  Local disk encryption ensures that your data stored on Linodes is secured. Disk encryption protects against unauthorized data access by keeping the data encrypted if the disk is ever removed from the data center, decommissioned, or disposed of. The platform manages the encryption and decryption for you.

  By default, encryption is enabled on all Linodes. If you opted out of encryption or if the Linode was created prior to local disk encryption support, you can encrypt your data using Rebuild.

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

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

  Beta Defines the maintenance policy for this Linode. Choose from the following policies:

  • linode/migrate: Migrates the Linode to a new host while it remains fully operational (with some performance degradation). Recommended for maximizing availability.
  • linode/power_off_on: Powers off the Linode at the start of the maintenance event and reboots it once the maintenance finishes. Recommended for maximizing performance.

  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.

• root_pass: string

  Write-only This sets the root user's password on a newly created Linode Disk when deploying from an Image.

  • Required when creating a Linode Disk from an Image, including when using a StackScript.

  • Must meet a password strength score requirement that is calculated internally by the API. If the strength requirement is not met, you will receive a Password does not meet strength requirement error.

• Optionalstackscript_data?: { [key: string]: unknown }

  This field is required only if the StackScript being deployed requires input data from the User for successful completion. See User Defined Fields (UDFs) for more details.

  This field is required to be valid JSON.

  Total length cannot exceed 65,535 characters.

• Optionalstackscript_id?: number

  A StackScript ID that will cause the referenced StackScript to be run during deployment of this Linode. A compatible image is required to use a StackScript. To get a list of available StackScript and their permitted Images, run List StackScripts. This field cannot be used when deploying from a Backup or a Private Image.

• Optionaltype?: string

  The ID of the Linode type to resize to with this request.

Type Declaration

• linodeId: number

  ID of the Linode to rebuild.