linodes

Overview

Name	linodes
Type	Resource
Id	linode.instances.linodes

Fields

Name	Datatype	Description
id	integer	This Linode's ID which must be provided for all operations impacting this Linode.
alerts	object
backups	object	Information about this Linode's backups status. For information about available backups, see /linode/instances/{linodeId}/backups.
created	string	When this Linode was created.
group	string	A deprecated property denoting a group label for this Linode.
host_uuid	string	The Linode's host machine, as a UUID.
hypervisor	string	The virtualization software powering this Linode.
image	string	An Image ID to deploy the Linode Disk from. Access the Images List (GET /images) endpoint 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. Access the User's Grant Update (PUT /account/users/{username}/grants) endpoint to adjust permissions for an Account Image.
ipv4	array	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 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	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 begin and end with an alphanumeric character. May only consist of alphanumeric characters, dashes (-), underscores (_) or periods (.). * Cannot have two dashes (--), underscores (__) or periods (..) in a row.
region	string	This is the Region where the Linode was deployed. A Linode's region can only be changed by initiating a cross data center migration.
specs	object	Information about the resources available to this Linode.
status	string	A brief description of this Linode's current state. This field may change without direct action from you. For example, when a Linode goes into maintenance mode its status will display "stopped".
tags	array	An array of tags applied to this object. Tags are for organizational purposes only.
type	string	This is the Linode Type that this Linode was deployed with. To change a Linode's Type, use POST /linode/instances/{linodeId}/resize.
updated	string	When this Linode was last updated.
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.

Methods

Name	Accessible by	Required Params	Description
getLinodeInstance	SELECT	linodeId	Get a specific Linode by ID.
getLinodeInstances	SELECT		Returns a paginated list of Linodes you have permission to view.
createLinodeInstance	INSERT	data__region, data__type	Creates a Linode Instance on your Account. In order for this request to complete successfully, your User must have the add_linodes grant. Creating a new Linode will incur a charge on your Account. Linodes can be created using one of the available Types. See Types List (GET /linode/types) to get more information about each Type's specs and cost. Linodes can be created in any one of our available Regions, which are accessible from the Regions List (GET /regions) endpoint. In an effort to fight spam, Linode restricts outbound connections on ports 25, 465, and 587 on all Linodes for new accounts created after November 5th, 2019. For more information, see Sending Email on Linode. Linodes can be created in a number of ways: Using a Linode Public Image distribution or a Private Image you created based on another Linode. Access the Images List (GET /images) endpoint with authentication to view all available Images. The Linode will be running after it completes provisioning. A default config with two Disks, one being a 512 swap disk, is created. swap_size can be used to customize the swap disk size. 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. You may also supply a list of usernames via the authorized_users field. These users must have an SSH Key associated with your Profile first. See SSH Key Add (POST /profile/sshkeys) for more information. Using a StackScript. See StackScripts List (GET /linode/stackscripts) for a list of available StackScripts. The Linode will be running after it completes provisioning. Requires a compatible Image to be supplied. See StackScript View (GET /linode/stackscript/{stackscriptId}) for compatible Images. 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. You may also supply a list of usernames via the authorized_users field. These users must have an SSH Key associated with your Profile first. See SSH Key Add (POST /profile/sshkeys) for more information. Using one of your other Linode's backups. You must create a Linode large enough to accommodate the Backup's size. The Disks and Config will match that of the Linode that was backed up. The root_pass will match that of the Linode that was backed up. Attached to a private VLAN. Review the interfaces property of the Request Body Schema for details. For more information, see our guide on Getting Started with VLANs. Create an empty Linode. The Linode will remain offline and must be manually started. See Linode Boot (POST /linode/instances/{linodeId}/boot). Disks and Configs must be created manually. This is only recommended for advanced use cases. Important: You must be an unrestricted User in order to add or modify tags on Linodes.
deleteLinodeInstance	DELETE	linodeId	Deletes a Linode you have permission to read_write. Deleting a Linode is a destructive action and cannot be undone. Additionally, deleting a Linode: Gives up any IP addresses the Linode was assigned. Deletes all Disks, Backups, Configs, etc. * Stops billing for the Linode and its associated services. You will be billed for time used within the billing period the Linode was active. Linodes that are in the process of cloning or backup restoration cannot be deleted.
_getLinodeInstance	EXEC	linodeId	Get a specific Linode by ID.
_getLinodeInstances	EXEC		Returns a paginated list of Linodes you have permission to view.
bootLinodeInstance	EXEC	linodeId	Boots a Linode you have permission to modify. If no parameters are given, a Config profile will be chosen for this boot based on the following criteria: If there is only one Config profile for this Linode, it will be used. If there is more than one Config profile, the last booted config will be used. * If there is more than one Config profile and none were the last to be booted (because the Linode was never booted or the last booted config was deleted) an error will be returned.
cloneLinodeInstance	EXEC	linodeId	You can clone your Linode's existing Disks or Configuration profiles to another Linode on your Account. In order for this request to complete successfully, your User must have the add_linodes grant. Cloning to a new Linode will incur a charge on your Account. If cloning to an existing Linode, any actions currently running or queued must be completed first before you can clone to it. Up to five clone operations from any given source Linode can be run concurrently. If more concurrent clones are attempted, an HTTP 400 error will be returned by this endpoint. Any tags existing on the source Linode will be cloned to the target Linode.
migrateLinodeInstance	EXEC	linodeId	Initiate a pending host migration that has been scheduled by Linode or initiate a cross data center (DC) migration. A list of pending migrations, if any, can be accessed from GET /account/notifications. When the migration begins, your Linode will be shutdown if not already off. If the migration initiated the shutdown, it will reboot the Linode when completed. To initiate a cross DC migration, you must pass a region parameter to the request body specifying the target data center region. You can view a list of all available regions and their feature capabilities from GET /regions. If your Linode has a DC migration already queued or you have initiated a previously scheduled migration, you will not be able to initiate a DC migration until it has completed. Note: Next Generation Network (NGN) data centers do not support IPv6 /116 pools or IP Failover. If you have these features enabled on your Linode and attempt to migrate to an NGN data center, the migration will not initiate. If a Linode cannot be migrated because of an incompatibility, you will be prompted to select a different data center or contact support.
mutateLinodeInstance	EXEC	linodeId	Linodes created with now-deprecated Types are entitled to a free upgrade to the next generation. A mutating Linode will be allocated any new resources the upgraded Type provides, and will be subsequently restarted if it was currently running. If any actions are currently running or queued, those actions must be completed first before you can initiate a mutate.
rebootLinodeInstance	EXEC	linodeId	Reboots a Linode you have permission to modify. If any actions are currently running or queued, those actions must be completed first before you can initiate a reboot.
rebuildLinodeInstance	EXEC	linodeId, data__image, data__root_pass	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.
rescueLinodeInstance	EXEC	linodeId	Rescue Mode is a safe environment for performing many system recovery and disk management tasks. Rescue Mode is based on the Finnix recovery distribution, a self-contained and bootable Linux distribution. You can also use Rescue Mode for tasks other than disaster recovery, such as formatting disks to use different filesystems, copying data between disks, and downloading files from a disk via SSH and SFTP. * Note that "sdh" is reserved and unavailable during rescue.
resetLinodePassword	EXEC	linodeId, data__root_pass	Resets the root password for this Linode. Your Linode must be shut down for a password reset to complete. If your Linode has more than one disk (not counting its swap disk), use the Reset Disk Root Password endpoint to update a specific disk's root password. * A password_reset event is generated when a root password reset is successful.
resizeLinodeInstance	EXEC	linodeId, data__type	Resizes a Linode you have the read_write permission to a different Type. If any actions are currently running or queued, those actions must be completed first before you can initiate a resize. Additionally, the following criteria must be met in order to resize a Linode: The Linode must not have a pending migration. Your Account cannot have an outstanding balance. The Linode must not have more disk allocation than the new Type allows. In that situation, you must first delete or resize the disk to be smaller.
shutdownLinodeInstance	EXEC	linodeId	Shuts down a Linode you have permission to modify. If any actions are currently running or queued, those actions must be completed first before you can initiate a shutdown.
updateLinodeInstance	EXEC	linodeId	Updates a Linode that you have permission to read_write. Important: You must be an unrestricted User in order to add or modify tags on Linodes.