array
of objects
Linode
Domain
Volume
NodeBalancer
object
object
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.
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.
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.
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.
object
Information about this Linode’s backups status. For information about available backups, see
/linode/instances/{linodeId}/backups
.
boolean
Whether Backups for this Linode are available for restoration.
Backups undergoing maintenance are not available for restoration.
boolean
If this Linode has the Backup service enabled. To enable backups, see
POST /linode/instances/{linodeId}/backups/enable
.
string<date-time>
The last successful backup date. ’null’ if there was no previous backup.
object
stringEnum:
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.
stringEnum:
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.
string<date-time>
When this Linode was created.
string
A deprecated property denoting a group label for this Linode.
boolean
Whether this compute instance was provisioned utilizing user_data provided via the Metadata service. See the
Linode Create
description for more information on Metadata.
string<uuid>
The Linode’s host machine, as a UUID.
stringEnum:
kvm
The virtualization software powering this Linode.
integer
This Linode’s ID which must be provided for all operations impacting this Linode.
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.
array
of strings
<ipv4>
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.
string<ipv6/128>
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.
string
3..64
characters
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, hyphens (-), underscores (_) or periods (.). Cannot have two hyphens (--), underscores (__) or periods (..) in a row. 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
.
object
Information about the resources available to this Linode.
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.
integer
The number of gpus this Linode has access to.
integer
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
/linode/instances/{linodeId}/configs
endpoints and the LinodeConfig object for more information.
integer
The amount of network transfer this Linode is allotted each month.
integer
The number of vcpus this Linode has access to.
stringEnum:
running
offline
booting
rebooting
shutting_down
provisioning
deleting
migrating
rebuilding
cloning
restoring
stopped
billing_suspension
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”.
array
of strings
An array of tags applied to this object. Tags are for organizational purposes only.
string
This is the
Linode Type
that this Linode was deployed with.
To change a Linode’s Type, use
POST /linode/instances/{linodeId}/resize
.
string<date-time>
When this Linode was last updated.
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.
object
A domain zonefile in our DNS system. You must own the domain name and tell your registrar to use Linode’s nameservers in order for a domain in our system to be treated as authoritative.
array
of strings
The list of IPs that may perform a zone transfer for this Domain. The total combined length of all data within this array cannot exceed 1000 characters.
Note : This is potentially dangerous, and should be set to an empty list unless you intend to use it.
string
1..253
characters
A description for this Domain. This is for display purposes only.
string
1..253
characters
The domain this Domain represents. Domain labels cannot be longer than 63 characters and must conform to RFC1035
. Domains must be unique on Linode’s platform, including across different Linode accounts; there cannot be two Domains representing the same domain.
integer
The amount of time in seconds that may pass before this Domain is no longer
authoritative.
Valid values are
0, 30, 120, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.
Any other value is rounded up to the nearest valid value.
A value of 0 is equivalent to the default value of 1209600.
string
1..50
characters
The group this Domain belongs to. This is for display purposes only.
integer
This Domain’s unique ID
array
of strings
The IP addresses representing the master DNS for this Domain. At least one value is required for type slave Domains. The total combined length of all data within this array cannot exceed 1000 characters.
integer
The amount of time in seconds before this Domain should be refreshed.
Valid values are
0, 30, 120, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.
Any other value is rounded up to the nearest valid value.
A value of 0 is equivalent to the default value of 14400.
integer
The interval, in seconds, at which a failed refresh should be retried.
Valid values are
0, 30, 120, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.
Any other value is rounded up to the nearest valid value.
A value of 0 is equivalent to the default value of 14400.
string<email>
Start of Authority email address. This is required for type master Domains.
stringEnum:
disabled
active
Default:
active
Used to control whether this Domain is currently being rendered.
array
of strings
An array of tags applied to this object. Tags are for organizational purposes only.
integer
“Time to Live” - the amount of time in seconds that this Domain’s records may be cached by resolvers or other domain servers.
Valid values are 0, 30, 120, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200. Any other value is rounded up to the nearest valid value. A value of 0 is equivalent to the default value of 86400. stringEnum:
master
slave
Whether this Domain represents the authoritative source of information for the domain it describes (“master”), or whether it is a read-only copy of a master (“slave”).
object
A Block Storage Volume associated with your Account.
string<date-time>
When this Volume was created.
string
The full filesystem path for the Volume based on the Volume’s label. Path is /dev/disk/by-id/scsi-0Linode_Volume_ + Volume label.
stringEnum:
hdd
nvme
The storage type of this Volume.
integer
The unique ID of this Volume.
string
1..32
characters
The Volume’s label is for display purposes only.
integer
If a Volume is attached to a specific Linode, the ID of that Linode will be displayed here.
string
If a Volume is attached to a specific Linode, the label of that Linode will be displayed here.
string
The unique ID of this Region.
integer
The Volume’s size, in GiB.
stringEnum:
creating
active
resizing
The current status of the volume. Can be one of:
creating - the Volume is being created and is not yet available
for use.active - the Volume is online and available for use.resizing - the Volume is in the process of upgrading
its current capacity.array
of strings
An array of Tags applied to this object. Tags are for organizational purposes only.
string<date-time>
When this Volume was last updated.
object
Linode’s load balancing solution. Can handle multiple ports, SSL termination, and any number of backends. NodeBalancer ports are configured with NodeBalancer Configs, and each config is given one or more NodeBalancer Node that accepts traffic. The traffic should be routed to the NodeBalancer’s ip address, the NodeBalancer will handle routing individual requests to backends.
integer
0..20
Throttle connections per second. Set to 0 (zero) to disable throttling.
string<date-time>
When this NodeBalancer was created.
string
This NodeBalancer’s hostname, beginning with its IP address and ending with .ip.linodeusercontent.com .
integer
This NodeBalancer’s unique ID.
string<ip>
This NodeBalancer’s public IPv4 address.
string<ip>
This NodeBalancer’s public IPv6 address.
string
3..32
characters
This NodeBalancer’s label. These must be unique on your Account.
string
The Region where this NodeBalancer is located. NodeBalancers only support backends in the same Region.
array
of strings
An array of Tags applied to this object. Tags are for organizational purposes only.
object
Information about the amount of transfer this NodeBalancer has had so far this month.
number
The total outbound transfer, in MB, used for this NodeBalancer this month.
number
The total inbound transfer, in MB, used for this NodeBalancer this month.
number
The total transfer, in MB, used by this NodeBalancer this month.
string<date-time>
When this NodeBalancer was last updated.
string
