Linode Instances

Rebuild Linode

post
https://api.linode.com/v4/linode/instances/{linodeId}/rebuild

Rebuilds a Linode you have the read_write permission to modify. A rebuild will first shut down the Linode, delete all disks and configs on the Linode, and then deploy a new image to the Linode with the given attributes. Additionally:

  • Requires an image be supplied.
  • Requires a root_pass be supplied to use for the root User's Account.
  • It is recommended to supply SSH keys for the root User using the authorized_keys field.

Authorizations

Personal Access Token
OAuth: ( linodes:read_write)

Path Parameters

linodeId
Required
integer

ID of the Linode to rebuild.

Request Body Schema

image
Required
string
root_pass
Required
string <password>
image
Required
string

An Image ID to deploy the Disk from. Official Linode Images start with linode/, while your Images start with private/. See /images for more information on the Images available for you to use.

root_pass
Required
string <password>[6 .. 128] characters ^(((?=.*[a-z])(?=.*[A-Z]))|((?=.*[a-z])(?=.*[0-9]))|((?=.*[A-Z])(?=.*[0-9]))|((?=.*[a-z])(?=.*[!"#$%&'()*+,-.\/:;<=>?@\[\]^_`{|}~\\]))|((?=.*[A-Z])(?=.*[!"#$%&'()*+,-.\/:;<=>?@\[\]^_`{|}~\\]))|((?=.*[0-9])(?=.*[!"#$%&'()*+,-.\/:;<=>?@\[\]^_`{|}~\\])))

This will set the root user's password on the newly-created Linode. The root password must conform to the following constraints:

  • May only use alphanumerics, punctuation, spaces, and tabs.
  • Must contain at least two of the following characters classes:
    • Upper-case letters
    • Lower-case letters
    • Digits
    • Punctuation
authorized_keys
array

A list of public SSH keys that will be automatically appended to the root user's ~/.ssh/authorized_keys file.

authorized_users
array

A list of usernames that will have their SSH keys, if any, automatically appended to the root user's ~/.ssh/authorized_keys file.

booted
boolean

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.

stackscript_data
object

This field is required only if the StackScript being deployed requires input data from the User for successful completion. See Variables and UDFs for more details. This field is required to be valid JSON.

stackscript_id
integer

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 see /stackscripts. This field cannot be used when deploying from a Backup or a private Image.

Request Samples

curl -H "Content-Type: application/json" \
    -H "Authorization: Bearer $TOKEN" \
    -X POST -d '{
      "image": "linode/debian9",
      "root_pass": "aComplexP@ssword",
      "authorized_keys": [
        "ssh-rsa AAAA_valid_public_ssh_key_123456785== user@their-computer"
      ],
      "authorized_users": [
        "myUsername",
        "secondaryUsername"
      ],
      "booted": true,
      "stackscript_id": 10079,
      "stackscript_data": {
        "gh_username": "linode"
      }
    }' \
    https://api.linode.com/v4/linode/instances/123/rebuild

Response Samples

{
  "id": 1234,
  "label": "",
  "status": "running",
  "type": "",
  "group": "Linode-Group",
  "tags": [],
  "created": "2018-01-01T00:01:01",
  "region": "",
  "image": "",
  "hypervisor": "kvm",
  "updated": "2018-01-01T00:01:01",
  "ipv4": [],
  "ipv6": "c001:d00d::1234",
  "specs": [
    {
      "disk": 81920,
      "memory": 4096,
      "vcpus": 2,
      "transfer": 4000
    }
  ],
  "alerts": [
    {
      "cpu": 180,
      "network_in": 10,
      "network_out": 10,
      "transfer_quota": 80,
      "io": 10000
    }
  ],
  "backups": [
    {
      "enabled": true,
      "schedule": ""
    }
  ],
  "watchdog_enabled": true
}

Responses

200: Rebuild started.

id
Filterable
integer

This Linode's ID which must be provided for all operations impacting this Linode.

label
Filterable

The Linode's label is for display purposes only. If no label is provided for a Linode, a default will be assigned. Linode labels have the following constraints:

  • Must start with an alpha character.
  • May only consist of alphanumeric characters, dashes (-), underscores (_) or periods (.).
  • Cannot have two dashes (--), underscores (__) or periods (..) in a row.
status
string
Enum: "running""offline""booting""rebooting""shutting_down""provisioning""deleting""migrating""rebuilding""cloning""restoring"

A brief description of this Linode's current state. This field may change without direct action from you. For instance, the status will change to "running" when the boot process completes.

type

This is the Linode Type that this Linode was deployed with. To change a Linode's Type, use POST /linode/instances/{linodeId}/resize.

group
Filterable
string
Deprecated

A deprecated property denoting a group label for this Linode.

tags
Filterable
array of objects

An array of tags applied to this object. Tags are for organizational purposes only.

created
string <date-time>

When this Linode was created.

region
Filterable

This is the location where the Linode was deployed. This cannot be changed without opening a support ticket.

image
Filterable
Nullable
hypervisor
string
Enum: "kvm"

The virtualization software powering this Linode.

updated
string <date-time>

When this Linode was last updated.

ipv4
array of objects

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 endpoints for details.

ipv6
string

This Linode's IPv6 SLAAC addresses. 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.

specs
object

Information about the resources available to this Linode.

disk
integer

The amount of storage space, in MB, this Linode has access to. A typical Linode will divide 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 POST /linode/instances. While this configuration is suitable for 99% of use cases, if you need finer control over your Linode's disks, see the /linode/instances/{linodeId}/disks endpoints.

memory
integer

The amount of RAM, in MB, this Linode has access to. Typically a Linode will choose to boot with all of its available RAM, but this can be configured in a Config profile, see the /linode/instances/{linodeId}/configs endpoints and the LinodeConfig object for more information.

vcpus
integer

The number of vcpus this Linode has access to. Typically a Linode will choose to boot with all of its available vcpus, but this can be configured in a Config Profile, see the /linode/instances/{linodeId}/configs endpoints and the LinodeConfig object for more information.

transfer
integer

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

alerts
object
cpu
integer

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.

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

network_in
integer

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
integer

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
integer

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.

io
integer

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.

backups
object

Information about this Linode's backups status. For information about available backups, see /linode/instances/{linodeId}/backups.

enabled
boolean

If this Linode has the Backup service enabled. To enable backups, see POST /linode/instances/{linodeId}/backups/enable.

schedule
object
day
Nullable
string
Enum: "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
Nullable
string
Enum: "Scheduling""W0""W2""W4""W6""W8""W10""W12""W14""W16""W18""W20""W22"

The window in which 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 do not choose a backup window, one will be selected for you automatically.

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

watchdog_enabled
boolean

The watchdog, named Lassie, is a Shutdown Watchdog that monitors your Linode and will reboot 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 will give up if there have been more than 5 boot jobs issued within 15 minutes.

default: Error

errors
array of objects
reason
string

What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.

field
string

The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.