Update a Linode

put

https://api.linode.com/{apiVersion}/linode/instances/{linodeId}

Updates a Linode.

📘
Updating tags?
If you include the tags object in this operation to modify the Linode's tags, you need to include existing tags to maintain them. You can run the List tagged objects operation to view your Linode, based on its label and store its current tags.

Permissions and scopes

To call this operation, you need permissions, based on the model you're using:

Identity and access permissions. Your user needs a role with these permissions. Learn more.
- Permissions: update_linode
OAuth scopes. Your user needs these scopes assigned. Learn more.
- Scopes: linodes:read_write

CLI

linode-cli linodes update 7833080 \
  --label linode123 \
  --backups.schedule.day "Saturday" \
  --backups.schedule.window "W22" \
  --alerts.cpu 180 \
  --alerts.network_in 10 \
  --alerts.network_out 10 \
  --alerts.transfer_quota 80 \
  --alerts.io 10000

Learn more

Path Params

apiVersion

string

enum

required

Enum Call either the v4 URL, or v4beta for operations still in Beta.

Allowed:

linodeId

integer

required

ID of the Linode to look up.

Body Params

alerts

object

backups

object

Information about this Linode's backups status. For information about available backups, run List backups.

group

string

deprecated

Deprecated, Filterable The group label for this Linode.

label

string

length between 3 and 64

Filterable Provides a name for the Linode. If not provided, the API generates one for it. A Linode label has some constraints:

It needs to begin and end with an alphanumeric character.
It can only consist of alphanumeric characters, hyphens (-), underscores (_), or periods (.).
It can't contain two consecutive hyphens (--), underscores (__) or periods (..).

maintenance_policy

string

enum

The maintenance policy configured by the user for this Linode. Review maintenance policy documentation for more details.

Allowed:

tags

array of strings

Filterable Tags to help you organize your content.

tags

watchdog_enabled

boolean

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

Responses

Response body

object

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.

The default value is 90% multiplied by the number of cores.

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

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.

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.

backups

object

Information about this Linode's backups status. For information about available backups, run List backups.

available

boolean

Read-only Whether backups for this Linode are available to restore. If a backup is currently undergoing maintenance, it's not available to restore.

enabled

boolean

Read-only If this Linode has the Backup service enabled. To enable backups, run Enable backups.

last_successful

date-time

Read-only The last successful backup time. Displayed as null if there was no previous backup.

schedule

object

capabilities

array of strings

Limited availability, Read-only A list of capabilities this compute instance supports.

capabilities

created

date-time

Read-only When this Linode was created.

disk_encryption

string | null

Defaults to enabled

Read-only Indicates the local disk encryption setting for this Linode. If the Linode is part of an LKE cluster, the value is null.

group

string

deprecated

Deprecated, Filterable The group label for this Linode.

has_user_data

boolean

Read-only Whether this compute instance was provisioned with user_data provided via the Metadata service. See the Create a Linode description for more information on Metadata.

host_uuid

uuid

Read-only The Linode's host machine, as a UUID.

hypervisor

string

enum

Read-only The virtualization software powering this Linode.

kvm

integer

Filterable, Read-only This Linode's ID which must be provided for all operations impacting this Linode.

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.

interface_generation

string

enum

Filterable, Read-only Indicates if the Linode is configured to use Linode interfaces (linode) or legacy configuration profile interfaces (legacy_config).

legacy_config linode

ipv4

array of strings

Filterable, Read-only 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 operations for details.

ipv4

ipv6

string | null

Read-only 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

length between 3 and 64

Filterable Provides a name for the Linode. If not provided, the API generates one for it. Linode labels have the following constraints:

It needs to begin and end with an alphanumeric character.
It can only consist of alphanumeric characters, hyphens (-), underscores (_), or periods (.).
It can't contain two consecutive hyphens (--), underscores (__) or periods (..).

lke_cluster_id

integer | null

Read-only The ID of the Kubernetes cluster if the Linode is part of cluster.

locks

array of strings

Beta A resource lock applied to the Linode. You can optionally set up this lock to prevent you from inadvertently deleting the Linode. Supported values here include:

cannot_delete. The Linode itself can't be deleted. Any sub-resources assigned to it can be freely deleted. You need to unlock the Linode by deleting its lock to delete the volume.
cannot_delete_with_subresources. The Linode and various sub-resources assigned to it can't be deleted. For example, if a Linode has a configuration profile interface assigned to it, this lock prevents you from deleting either of them. You need to unlock the resource (the Linode) by deleting its lock. Then you can delete the Linode and any of its sub-resources.
Empty. The Linode doesn't have a resource lock configured. When you clone a Linode, this array is empty because resource lock settings aren't carried to the cloned Linode.

📘
This array appears for a Linode only if you call this operation using the v4beta path parameter in the URL.

locks

maintenance_policy

string

enum

The maintenance policy configured by the user for this Linode. Review maintenance policy documentation for more details.

linode/migrate linode/power_off_on

placement_group

object | null

Read-only Details on the placement group that this Linode belongs to. Empty if the Linode isn't in a placement group.

integer

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

label

string

length ≥ 1

Filterable The unique name set for the placement group. A label has these constraints:

It needs to begin and end with an alphanumeric character.
It can only consist of alphanumeric characters, hyphens (-), underscores (_), or periods (.).

placement_group_policy

string

enum

How requests to add future Linodes to your placement group are handled, and whether it remains compliant:

strict. Don't assign a new Linode if it breaks the grouped-together or spread-apart model set by the placement_group_type. Use this to ensure the placement group stays compliant (is_compliant: true).
flexible. Assign a new Linode, even if it breaks the grouped-together or spread-apart model set by the placement_group_type. This makes the group non-compliant (is_compliant: false). You need to wait for Akamai to move the offending Linode to make it compliant again, once the necessary capacity is available in the region. Offers flexibility to add future Linodes if compliance isn't an immediate concern.

📘
In rare cases, non-compliance can occur with a strict placement group if Akamai needs to failover or migrate your Linodes for maintenance. Fixing non-compliance for a strict placement group is prioritized over a flexible group.

strict flexible

placement_group_type

string

enum

Filterable, Read-only How Linodes are distributed in your placement group. A placement_group_type using anti-affinity (anti_affinity:local) places Linodes in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A placement_group_type using affinity places Linodes physically close together, possibly on the same host. This supports the grouped-together model for low-latency.

📘
Currently, only anti_affinity:local is available for placement_group_type.

anti_affinity:local

region

string

Filterable, Read-only The region where the Linode deployed. A Linode's region can only be changed by initiating a cross data center migration.

specs

object

Read-only Information about the resources available to this Linode.

disk

integer

Read-only The amount of storage space, in MB, this Linode has access to. A typical Linode divides 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 Create a Linode. While this configuration is suitable for most use cases, if you need finer control over your Linode's disks, see the List disks operations.

gpus

integer

Read-only The number of GPUs this Linode has access to.

memory

integer

Read-only The amount of RAM, in MB, this Linode has access to.

Typically, a Linode boots with all of its available RAM, but this can be configured in a config profile. See the List config profiles operation for more information.

transfer

integer

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

vcpus

integer

Read-only The number of VCPUs this Linode has access to.

status

string

enum

Read-only A brief description of this Linode's current state. This field may change without direct action from you. For example, when a compute instance goes into maintenance mode, its status is stopped. Status is generally self-explanatory, based on its name.

busy indicates you've assigned the compute instance to a placement group, but the compute instance is currently booting. Once the boot completes, the API completes the assignment and updates the compute instance's status accordingly.
provisioning indicates that the API is applying operating system or Marketplace applications on the compute instance.
billing_suspension indicates that payment is past due on the compute instance, so we've suspended its use.

running offline booting busy rebooting shutting_down provisioning deleting migrating rebuilding cloning restoring stopped billing_suspension

tags

array of strings

Filterable Tags to help you organize your content.

tags

type

string

Read-only This is the Linode type that it was deployed with. To change a Linode's type, use Resize a Linode.

updated

date-time

Read-only When this Linode was last updated.

watchdog_enabled

boolean

Language

Credentials


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://api.linode.com/v4/linode/instances/linodeId \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
64
}
1
{
2
  "alerts": {
3
    "cpu": 180,
4
    "io": 10000,
5
    "network_in": 10,
6
    "network_out": 10,
7
    "transfer_quota": 80
8
  },
9
  "backups": {
10
    "available": true,
11
    "enabled": true,
12
    "last_successful": "2018-01-01T00:01:01",
13
    "schedule": {
14
      "day": "Saturday",
15
      "window": "W22"
16
    }
17
  },
18
  "capabilities": [
19
    "Block Storage Encryption"
20
  ],
21
  "created": "2018-01-01T00:01:01",
22
  "disk_encryption": "disabled",
23
  "has_user_data": true,
24
  "host_uuid": "1a2bcd34e5f67gh8ij901234567kl89mn01opqr2",
25
  "hypervisor": "kvm",
26
  "id": 123,
27
  "image": "linode/debian10",
28
  "interface_generation": "linode",
29
  "ipv4": [
30
    "203.0.113.1",
31
    "192.0.2.1"
32
  ],
33
  "ipv6": "2001:DB8::/128",
34
  "label": "linode123",
35
  "lke_cluster_id": 1,
36
  "locks": [
37
    "cannot_delete"
38
  ],
39
  "maintenance_policy": "linode/migrate",
40
  "placement_group": {
41
    "id": 528,
42
    "label": "PG_Miami_failover",
43
    "migrating_to": 2468,
44
    "placement_group_policy": "strict",
45
    "placement_group_type": "anti_affinity:local"
46
  },
47
  "region": "us-east",
48
  "site_type": "core",

200The updated Linode.

defaultSee Errors for the range of possible error response codes.