struct
ACTION api.spec
DATA
struct
METHODS
struct
account.estimateinvoice
struct
DESCRIPTION Estimates the invoice for adding a new Linode or NodeBalancer as well as resizing a Linode. This returns two fields: PRICE which is the estimated cost of the invoice, and INVOICE_TO which is the date invoice would be though with timezone set to America/New_York
PARAMETERS
struct
LinodeID
struct
DESCRIPTION This is the LinodeID you want to resize and is required for mode 'linode_resize'.
NAME LinodeID
REQUIRED false
TYPE numeric
PaymentTerm
struct
DESCRIPTION Subscription term in months. One of: 1, 12, or 24. This is required for modes 'linode_new' and 'nodebalancer_new'.
NAME PaymentTerm
REQUIRED false
TYPE numeric
PlanID
struct
DESCRIPTION The desired PlanID available from avail.LinodePlans(). This is required for modes 'linode_new' and 'linode_resize'.
NAME PlanID
REQUIRED false
TYPE numeric
mode
struct
DESCRIPTION This is one of the following options: 'linode_new', 'linode_resize', or 'nodebalancer_new'.
NAME mode
REQUIRED true
TYPE string
THROWS VALIDATION
account.info
struct
DESCRIPTION Shows information about your account such as the date your account was opened as well as your network utilization for the current month in gigabytes.
PARAMETERS
struct [empty]
THROWS [empty string]
account.paybalance
struct
DESCRIPTION Pays current balance on file, returning it in the response.
PARAMETERS
struct [empty]
THROWS CCEXPIRED,CCFAILED,NOACCESS,PAYMENTLIMITER,VALIDATION
account.updatecard
struct
DESCRIPTION [empty string]
PARAMETERS
struct
ccExpMonth
struct
DESCRIPTION [empty string]
NAME ccExpMonth
REQUIRED true
TYPE numeric
ccExpYear
struct
DESCRIPTION [empty string]
NAME ccExpYear
REQUIRED true
TYPE numeric
ccNumber
struct
DESCRIPTION [empty string]
NAME ccNumber
REQUIRED true
TYPE numeric
THROWS [empty string]
api.spec
struct
DESCRIPTION Returns a data structure of the entire Linode API specification. This method does not require authorization.<br><br>For example: <a target="_blank" href="https://api.linode.com/?api_action=api.spec">https://api.linode.com/?api_action=api.spec</a>
PARAMETERS
struct [empty]
THROWS [empty string]
avail.datacenters
struct
DESCRIPTION Returns a list of Linode data center facilities.
PARAMETERS
struct [empty]
THROWS [empty string]
avail.distributions
struct
DESCRIPTION Returns a list of available Linux Distributions.
PARAMETERS
struct
DistributionID
struct
DESCRIPTION Limits the results to the specified DistributionID
NAME DistributionID
REQUIRED false
TYPE numeric
THROWS [empty string]
avail.kernels
struct
DESCRIPTION List available kernels.
PARAMETERS
struct
isKVM
struct
DESCRIPTION Show or hide KVM compatible kernels
NAME isKVM
REQUIRED false
TYPE boolean
isXen
struct
DESCRIPTION Show or hide Xen compatible kernels
NAME isXen
REQUIRED false
TYPE boolean
THROWS [empty string]
avail.linodeplans
struct
DESCRIPTION Returns a structure of Linode PlanIDs containing the Plan label and the availability in each Datacenter.
PARAMETERS
struct
PlanID
struct
DESCRIPTION Limits the list to the specified PlanID
NAME PlanID
REQUIRED false
TYPE numeric
THROWS [empty string]
avail.nodebalancers
struct
DESCRIPTION Returns NodeBalancer pricing information.
PARAMETERS
struct [empty]
THROWS [empty string]
avail.stackscripts
struct
DESCRIPTION Returns a list of available public StackScripts.
PARAMETERS
struct
DistributionID
struct
DESCRIPTION Limit the results to StackScripts that can be applied to this DistributionID
NAME DistributionID
REQUIRED false
TYPE numeric
DistributionVendor
struct
DESCRIPTION Debian, Ubuntu, Fedora, etc.
NAME DistributionVendor
REQUIRED false
TYPE string
keywords
struct
DESCRIPTION Search terms
NAME keywords
REQUIRED false
TYPE string
THROWS [empty string]
domain.create
struct
DESCRIPTION Create a domain record.
PARAMETERS
struct
Description
struct
DESCRIPTION Currently undisplayed.
NAME Description
REQUIRED false
TYPE string
default [empty string]
Domain
struct
DESCRIPTION The zone's name
NAME Domain
REQUIRED true
TYPE string
Expire_sec
struct
DESCRIPTION [empty string]
NAME Expire_sec
REQUIRED false
TYPE numeric
default 0
Refresh_sec
struct
DESCRIPTION [empty string]
NAME Refresh_sec
REQUIRED false
TYPE numeric
default 0
Retry_sec
struct
DESCRIPTION [empty string]
NAME Retry_sec
REQUIRED false
TYPE numeric
default 0
SOA_Email
struct
DESCRIPTION Required when type=master
NAME SOA_Email
REQUIRED false
TYPE string
default [empty string]
TTL_sec
struct
DESCRIPTION [empty string]
NAME TTL_sec
REQUIRED false
TYPE numeric
default 0
Type
struct
DESCRIPTION master or slave
NAME Type
REQUIRED true
TYPE string
axfr_ips
struct
DESCRIPTION IP addresses allowed to AXFR the entire zone, semicolon separated
NAME axfr_ips
REQUIRED false
TYPE string
default [empty string]
lpm_displayGroup
struct
DESCRIPTION Display group in the Domain list inside the Linode DNS Manager
NAME lpm_displayGroup
REQUIRED false
TYPE string
default [empty string]
master_ips
struct
DESCRIPTION When type=slave, the zone's master DNS servers list, semicolon separated
NAME master_ips
REQUIRED false
TYPE string
default [empty string]
status
struct
DESCRIPTION 0, 1, or 2 (disabled, active, edit mode)
NAME status
REQUIRED false
TYPE numeric
default 1
THROWS NOACCESS,VALIDATION
domain.delete
struct
DESCRIPTION [empty string]
PARAMETERS
struct
DomainID
struct
DESCRIPTION [empty string]
NAME DomainID
REQUIRED true
TYPE numeric
THROWS NOTFOUND
domain.list
struct
DESCRIPTION Lists domains you have access to.
PARAMETERS
struct
DomainID
struct
DESCRIPTION Limits the list to the specified DomainID
NAME DomainID
REQUIRED false
TYPE numeric
THROWS [empty string]
domain.resource.create
struct
DESCRIPTION Create a domain record.
PARAMETERS
struct
DomainID
struct
DESCRIPTION [empty string]
NAME DomainID
REQUIRED true
TYPE numeric
Name
struct
DESCRIPTION The hostname or FQDN. When Type=MX the subdomain to delegate to the Target MX server.
NAME Name
REQUIRED false
TYPE string
default [empty string]
Port
struct
DESCRIPTION [empty string]
NAME Port
REQUIRED false
TYPE numeric
default 80
Priority
struct
DESCRIPTION Priority for MX and SRV records, 0-255
NAME Priority
REQUIRED false
TYPE numeric
default 10
Protocol
struct
DESCRIPTION The protocol to append to an SRV record. Ignored on other record types.
NAME Protocol
REQUIRED false
TYPE string
default [empty string]
TTL_sec
struct
DESCRIPTION TTL. Leave as 0 to accept our default.
NAME TTL_sec
REQUIRED false
TYPE numeric
default 0
Target
struct
DESCRIPTION When Type=MX the hostname. When Type=CNAME the target of the alias. When Type=TXT the value of the record. When Type=A or AAAA the token of '[remote_addr]' will be substituted with the IP address of the request.
NAME Target
REQUIRED false
TYPE string
default [empty string]
Type
struct
DESCRIPTION One of: NS, MX, A, AAAA, CNAME, TXT, or SRV
NAME Type
REQUIRED true
TYPE string
Weight
struct
DESCRIPTION [empty string]
NAME Weight
REQUIRED false
TYPE numeric
default 5
THROWS NOACCESS,VALIDATION
domain.resource.delete
struct
DESCRIPTION [empty string]
PARAMETERS
struct
DomainID
struct
DESCRIPTION [empty string]
NAME DomainID
REQUIRED true
TYPE numeric
ResourceID
struct
DESCRIPTION [empty string]
NAME ResourceID
REQUIRED true
TYPE numeric
THROWS NOTFOUND
domain.resource.list
struct
DESCRIPTION [empty string]
PARAMETERS
struct
DomainID
struct
DESCRIPTION [empty string]
NAME DomainID
REQUIRED true
TYPE numeric
ResourceID
struct
DESCRIPTION [empty string]
NAME ResourceID
REQUIRED false
TYPE numeric
THROWS [empty string]
domain.resource.update
struct
DESCRIPTION Update a domain record.
PARAMETERS
struct
DomainID
struct
DESCRIPTION [empty string]
NAME DomainID
REQUIRED false
TYPE numeric
Name
struct
DESCRIPTION The hostname or FQDN. When Type=MX the subdomain to delegate to the Target MX server.
NAME Name
REQUIRED false
TYPE string
Port
struct
DESCRIPTION [empty string]
NAME Port
REQUIRED false
TYPE numeric
Priority
struct
DESCRIPTION Priority for MX and SRV records, 0-255
NAME Priority
REQUIRED false
TYPE numeric
Protocol
struct
DESCRIPTION The protocol to append to an SRV record. Ignored on other record types.
NAME Protocol
REQUIRED false
TYPE string
ResourceID
struct
DESCRIPTION [empty string]
NAME ResourceID
REQUIRED true
TYPE numeric
TTL_sec
struct
DESCRIPTION TTL. Leave as 0 to accept our default.
NAME TTL_sec
REQUIRED false
TYPE numeric
Target
struct
DESCRIPTION When Type=MX the hostname. When Type=CNAME the target of the alias. When Type=TXT the value of the record. When Type=A or AAAA the token of '[remote_addr]' will be substituted with the IP address of the request.
NAME Target
REQUIRED false
TYPE string
Weight
struct
DESCRIPTION [empty string]
NAME Weight
REQUIRED false
TYPE numeric
THROWS NOTFOUND,VALIDATION
domain.update
struct
DESCRIPTION Update a domain record.
PARAMETERS
struct
Description
struct
DESCRIPTION Currently undisplayed.
NAME Description
REQUIRED false
TYPE string
Domain
struct
DESCRIPTION The zone's name
NAME Domain
REQUIRED false
TYPE string
DomainID
struct
DESCRIPTION [empty string]
NAME DomainID
REQUIRED true
TYPE numeric
Expire_sec
struct
DESCRIPTION [empty string]
NAME Expire_sec
REQUIRED false
TYPE numeric
Refresh_sec
struct
DESCRIPTION [empty string]
NAME Refresh_sec
REQUIRED false
TYPE numeric
Retry_sec
struct
DESCRIPTION [empty string]
NAME Retry_sec
REQUIRED false
TYPE numeric
SOA_Email
struct
DESCRIPTION Required when type=master
NAME SOA_Email
REQUIRED false
TYPE string
TTL_sec
struct
DESCRIPTION [empty string]
NAME TTL_sec
REQUIRED false
TYPE numeric
Type
struct
DESCRIPTION master or slave
NAME Type
REQUIRED false
TYPE string
axfr_ips
struct
DESCRIPTION IP addresses allowed to AXFR the entire zone, semicolon separated
NAME axfr_ips
REQUIRED false
TYPE string
lpm_displayGroup
struct
DESCRIPTION Display group in the Domain list inside the Linode DNS Manager
NAME lpm_displayGroup
REQUIRED false
TYPE string
master_ips
struct
DESCRIPTION When type=slave, the zone's master DNS servers list, semicolon separated
NAME master_ips
REQUIRED false
TYPE string
status
struct
DESCRIPTION 0, 1, or 2 (disabled, active, edit mode)
NAME status
REQUIRED false
TYPE numeric
THROWS NOTFOUND,VALIDATION
image.delete
struct
DESCRIPTION Deletes a gold-master image
PARAMETERS
struct
ImageID
struct
DESCRIPTION The ID of the gold-master image to delete
NAME ImageID
REQUIRED true
TYPE numeric
THROWS NOTFOUND
image.list
struct
DESCRIPTION Lists available gold-master images
PARAMETERS
struct
ImageID
struct
DESCRIPTION Request information for a specific gold-master image
NAME ImageID
REQUIRED false
TYPE numeric
pending
struct
DESCRIPTION Show images currently being created.
NAME pending
REQUIRED false
TYPE numeric
THROWS NOTFOUND
image.update
struct
DESCRIPTION Update an Image record.
PARAMETERS
struct
ImageID
struct
DESCRIPTION The ID of the Image to modify.
NAME ImageID
REQUIRED true
TYPE numeric
description
struct
DESCRIPTION An optional description of the Image.
NAME description
REQUIRED false
TYPE string
label
struct
DESCRIPTION The label of the Image.
NAME label
REQUIRED false
TYPE string
THROWS NOTFOUND,VALIDATION
linode.boot
struct
DESCRIPTION Issues a boot job for the provided ConfigID. If no ConfigID is provided boots the last used configuration profile, or the first configuration profile if this Linode has never been booted.
PARAMETERS
struct
ConfigID
struct
DESCRIPTION The ConfigID to boot, available from linode.config.list().
NAME ConfigID
REQUIRED false
TYPE numeric
LinodeID
struct
DESCRIPTION [empty string]
NAME LinodeID
REQUIRED true
TYPE numeric
THROWS NOTFOUND
linode.clone
struct
DESCRIPTION Creates a new Linode, assigns you full privileges, and then clones the specified LinodeID to the new Linode. There is a limit of 5 active clone operations per source Linode. It is recommended that the source Linode be powered down during the clone.
PARAMETERS
struct
DatacenterID
struct
DESCRIPTION The DatacenterID from avail.datacenters() where you wish to place this new Linode
NAME DatacenterID
REQUIRED true
TYPE numeric
LinodeID
struct
DESCRIPTION The LinodeID that you want cloned
NAME LinodeID
REQUIRED true
TYPE numeric
PaymentTerm
struct
DESCRIPTION Subscription term in months for prepaid customers. One of: 1, 12, or 24
NAME PaymentTerm
REQUIRED false
TYPE numeric
PlanID
struct
DESCRIPTION The desired PlanID available from avail.LinodePlans()
NAME PlanID
REQUIRED true
TYPE numeric
THROWS NOACCESS,NOTFOUND,CCFAILED,VALIDATION,LINODELIMITER,ACCOUNTLIMIT
linode.config.create
struct
DESCRIPTION Creates a Linode Configuration Profile.
PARAMETERS
struct
Comments
struct
DESCRIPTION Comments you wish to save along with this profile
NAME Comments
REQUIRED false
TYPE string
default [empty string]
DiskList
struct
DESCRIPTION A comma delimited list of DiskIDs; position reflects device node. The 9th element for specifying the initrd.
NAME DiskList
REQUIRED true
TYPE string
KernelID
struct
DESCRIPTION The KernelID for this profile. Found in avail.kernels()
NAME KernelID
REQUIRED true
TYPE numeric
Label
struct
DESCRIPTION The Label for this profile
NAME Label
REQUIRED true
TYPE string
LinodeID
struct
DESCRIPTION [empty string]
NAME LinodeID
REQUIRED true
TYPE numeric
RAMLimit
struct
DESCRIPTION RAMLimit in MB. 0 for max.
NAME RAMLimit
REQUIRED false
TYPE numeric
default 0
RootDeviceCustom
struct
DESCRIPTION A custom root device setting.
NAME RootDeviceCustom
REQUIRED false
TYPE string
default [empty string]
RootDeviceNum
struct
DESCRIPTION Which device number (1-8) that contains the root partition. 0 to utilize RootDeviceCustom.
NAME RootDeviceNum
REQUIRED false
TYPE numeric
default 1
RootDeviceRO
struct
DESCRIPTION Enables the 'ro' kernel flag. Modern distros want this.
NAME RootDeviceRO
REQUIRED false
TYPE boolean
default true
RunLevel
struct
DESCRIPTION One of 'default', 'single', 'binbash'
NAME RunLevel
REQUIRED false
TYPE string
default default
devtmpfs_automount
struct
DESCRIPTION Controls if pv_ops kernels should automount devtmpfs at boot.
NAME devtmpfs_automount
REQUIRED false
TYPE boolean
default true
helper_depmod
struct
DESCRIPTION Creates an empty modprobe file for the kernel you're booting.
NAME helper_depmod
REQUIRED false
TYPE boolean
default true
helper_disableUpdateDB
struct
DESCRIPTION Enable the disableUpdateDB filesystem helper
NAME helper_disableUpdateDB
REQUIRED false
TYPE boolean
default true
helper_distro
struct
DESCRIPTION Enable the Distro filesystem helper. Corrects fstab and inittab/upstart entries depending on the kernel you're booting. You want this.
NAME helper_distro
REQUIRED false
TYPE boolean
default true
helper_network
struct
DESCRIPTION Automatically creates network configuration files for your distro and places them into your filesystem.
NAME helper_network
REQUIRED false
TYPE boolean
default true
helper_xen
struct
DESCRIPTION Deprecated - use helper_distro.
NAME helper_xen
REQUIRED false
TYPE boolean
default true
virt_mode
struct
DESCRIPTION Controls the virtualization mode. One of 'paravirt', 'fullvirt'
NAME virt_mode
REQUIRED false
TYPE string
default paravirt
THROWS NOTFOUND,VALIDATION
linode.config.delete
struct
DESCRIPTION Deletes a Linode Configuration Profile.
PARAMETERS
struct
ConfigID
struct
DESCRIPTION [empty string]
NAME ConfigID
REQUIRED true
TYPE numeric
LinodeID
struct
DESCRIPTION [empty string]
NAME LinodeID
REQUIRED true
TYPE numeric
THROWS NOTFOUND,VALIDATION
linode.config.list
struct
DESCRIPTION Lists a Linode's Configuration Profiles.
PARAMETERS
struct
ConfigID
struct
DESCRIPTION [empty string]
NAME ConfigID
REQUIRED false
TYPE numeric
LinodeID
struct
DESCRIPTION [empty string]
NAME LinodeID
REQUIRED true
TYPE numeric
THROWS NOTFOUND
linode.config.update
struct
DESCRIPTION Updates a Linode Configuration Profile.
PARAMETERS
struct
Comments
struct
DESCRIPTION Comments you wish to save along with this profile
NAME Comments
REQUIRED false
TYPE string
ConfigID
struct
DESCRIPTION [empty string]
NAME ConfigID
REQUIRED true
TYPE numeric
DiskList
struct
DESCRIPTION A comma delimited list of DiskIDs; position reflects device node. The 9th element for specifying the initrd.
NAME DiskList
REQUIRED false
TYPE string
KernelID
struct
DESCRIPTION The KernelID for this profile. Found in avail.kernels()
NAME KernelID
REQUIRED false
TYPE numeric
Label
struct
DESCRIPTION The Label for this profile
NAME Label
REQUIRED false
TYPE string
LinodeID
struct
DESCRIPTION [empty string]
NAME LinodeID
REQUIRED false
TYPE numeric
RAMLimit
struct
DESCRIPTION RAMLimit in MB. 0 for max.
NAME RAMLimit
REQUIRED false
TYPE numeric
RootDeviceCustom
struct
DESCRIPTION A custom root device setting.
NAME RootDeviceCustom
REQUIRED false
TYPE string
RootDeviceNum
struct
DESCRIPTION Which device number (1-8) that contains the root partition. 0 to utilize RootDeviceCustom.
NAME RootDeviceNum
REQUIRED false
TYPE numeric
RootDeviceRO
struct
DESCRIPTION Enables the 'ro' kernel flag. Modern distros want this.
NAME RootDeviceRO
REQUIRED false
TYPE boolean
RunLevel
struct
DESCRIPTION One of 'default', 'single', 'binbash'
NAME RunLevel
REQUIRED false
TYPE string
devtmpfs_automount
struct
DESCRIPTION Controls if pv_ops kernels should automount devtmpfs at boot.
NAME devtmpfs_automount
REQUIRED false
TYPE boolean
helper_depmod
struct
DESCRIPTION Creates an empty modprobe file for the kernel you're booting.
NAME helper_depmod
REQUIRED false
TYPE boolean
helper_disableUpdateDB
struct
DESCRIPTION Enable the disableUpdateDB filesystem helper
NAME helper_disableUpdateDB
REQUIRED false
TYPE boolean
helper_distro
struct
DESCRIPTION Enable the Distro filesystem helper. Corrects fstab and inittab/upstart entries depending on the kernel you're booting. You want this.
NAME helper_distro
REQUIRED false
TYPE boolean
helper_network
struct
DESCRIPTION Automatically creates network configuration files for your distro and places them into your filesystem.
NAME helper_network
REQUIRED false
TYPE boolean
helper_xen
struct
DESCRIPTION Deprecated - use helper_distro.
NAME helper_xen
REQUIRED false
TYPE boolean
virt_mode
struct
DESCRIPTION Controls the virtualization mode. One of 'paravirt', 'fullvirt'
NAME virt_mode
REQUIRED false
TYPE string
THROWS NOTFOUND,VALIDATION
linode.create
struct
DESCRIPTION Creates a Linode and assigns you full privileges. There is a 75-linodes-per-hour limiter.
PARAMETERS
struct
DatacenterID
struct
DESCRIPTION The DatacenterID from avail.datacenters() where you wish to place this new Linode
NAME DatacenterID
REQUIRED true
TYPE numeric
PaymentTerm
struct
DESCRIPTION Subscription term in months for prepaid customers. One of: 1, 12, or 24
NAME PaymentTerm
REQUIRED false
TYPE numeric
default 1
PlanID
struct
DESCRIPTION The desired PlanID available from avail.LinodePlans()
NAME PlanID
REQUIRED true
TYPE numeric
THROWS NOACCESS,CCFAILED,VALIDATION,LINODELIMITER,ACCOUNTLIMIT
linode.delete
struct
DESCRIPTION Immediately removes a Linode from your account and issues a pro-rated credit back to your account, if applicable. To prevent accidental deletes, this requires the Linode has no Disk images. You must first delete its disk images."
PARAMETERS
struct
LinodeID
struct
DESCRIPTION The LinodeID to delete
NAME LinodeID
REQUIRED true
TYPE numeric
skipChecks
struct
DESCRIPTION Skips the safety checks and will always delete the Linode
NAME skipChecks
REQUIRED false
TYPE boolean
THROWS NOTFOUND,LINODENOTEMPTY
linode.disk.create
struct
DESCRIPTION [empty string]
PARAMETERS
struct
FromDistributionID
struct
DESCRIPTION [empty string]
NAME FromDistributionID
REQUIRED false
TYPE numeric
default 0
Label
struct
DESCRIPTION The display label for this Disk
NAME Label
REQUIRED true
TYPE string
LinodeID
struct
DESCRIPTION [empty string]
NAME LinodeID
REQUIRED true
TYPE numeric
Size
struct
DESCRIPTION The size in MB of this Disk.
NAME Size
REQUIRED true
TYPE numeric
Type
struct
DESCRIPTION The formatted type of this disk. Valid types are: ext3, ext4, swap, raw
NAME Type
REQUIRED true
TYPE string
isReadOnly
struct
DESCRIPTION Enable forced read-only for this Disk
NAME isReadOnly
REQUIRED false
TYPE boolean
default false
rootPass
struct
DESCRIPTION [empty string]
NAME rootPass
REQUIRED false
TYPE string
default [empty string]
rootSSHKey
struct
DESCRIPTION [empty string]
NAME rootSSHKey
REQUIRED false
TYPE string
default [empty string]
THROWS NOTFOUND,VALIDATION
linode.disk.createfromdistribution
struct
DESCRIPTION [empty string]
PARAMETERS
struct
DistributionID
struct
DESCRIPTION The DistributionID to create this disk from. Found in avail.distributions()
NAME DistributionID
REQUIRED true
TYPE numeric
Label
struct
DESCRIPTION The label of this new disk image
NAME Label
REQUIRED true
TYPE string
LinodeID
struct
DESCRIPTION [empty string]
NAME LinodeID
REQUIRED true
TYPE numeric
Size
struct
DESCRIPTION Size of this disk image in MB
NAME Size
REQUIRED true
TYPE numeric
rootPass
struct
DESCRIPTION The root user's password
NAME rootPass
REQUIRED true
TYPE string
rootSSHKey
struct
DESCRIPTION Optionally sets this string into /root/.ssh/authorized_keys upon distribution configuration.
NAME rootSSHKey
REQUIRED false
TYPE string
THROWS NOTFOUND,VALIDATION
linode.disk.createfromimage
struct
DESCRIPTION Creates a new disk from a previously imagized disk.
PARAMETERS
struct
ImageID
struct
DESCRIPTION The ID of the frozen image to deploy from
NAME ImageID
REQUIRED true
TYPE numeric
Label
struct
DESCRIPTION The label of this new disk image
NAME Label
REQUIRED false
TYPE string
LinodeID
struct
DESCRIPTION Specifies the Linode to deploy on to
NAME LinodeID
REQUIRED true
TYPE numeric
rootPass
struct
DESCRIPTION Optionally sets the root password at deployment time. If a password is not provided the existing root password of the frozen image will not be modified
NAME rootPass
REQUIRED false
TYPE string
rootSSHKey
struct
DESCRIPTION Optionally sets this string into /root/.ssh/authorized_keys upon image deployment
NAME rootSSHKey
REQUIRED false
TYPE string
size
struct
DESCRIPTION The size of the disk image to creates. Defaults to the minimum size required for the requested image
NAME size
REQUIRED false
TYPE numeric
THROWS [empty string]
linode.disk.createfromstackscript
struct
DESCRIPTION [empty string]
PARAMETERS
struct
DistributionID
struct
DESCRIPTION Which Distribution to apply this StackScript to. Must be one from the script's DistributionIDList
NAME DistributionID
REQUIRED true
TYPE numeric
Label
struct
DESCRIPTION The label of this new disk image
NAME Label
REQUIRED true
TYPE string
LinodeID
struct
DESCRIPTION [empty string]
NAME LinodeID
REQUIRED true
TYPE numeric
Size
struct
DESCRIPTION Size of this disk image in MB
NAME Size
REQUIRED true
TYPE numeric
StackScriptID
struct
DESCRIPTION The StackScript to create this image from
NAME StackScriptID
REQUIRED true
TYPE numeric
StackScriptUDFResponses
struct
DESCRIPTION JSON encoded name/value pairs, answering this StackScript's User Defined Fields
NAME StackScriptUDFResponses
REQUIRED true
TYPE string
rootPass
struct
DESCRIPTION The root user's password
NAME rootPass
REQUIRED true
TYPE string
rootSSHKey
struct
DESCRIPTION Optionally sets this string into /root/.ssh/authorized_keys upon distribution configuration.
NAME rootSSHKey
REQUIRED false
TYPE string
THROWS NOTFOUND,VALIDATION
linode.disk.delete
struct
DESCRIPTION [empty string]
PARAMETERS
struct
DiskID
struct
DESCRIPTION [empty string]
NAME DiskID
REQUIRED true
TYPE numeric
LinodeID
struct
DESCRIPTION [empty string]
NAME LinodeID
REQUIRED true
TYPE numeric
THROWS NOTFOUND,VALIDATION
linode.disk.duplicate
struct
DESCRIPTION Performs a bit-for-bit copy of a disk image.
PARAMETERS
struct
DiskID
struct
DESCRIPTION [empty string]
NAME DiskID
REQUIRED true
TYPE numeric
LinodeID
struct
DESCRIPTION [empty string]
NAME LinodeID
REQUIRED true
TYPE numeric
THROWS NOTFOUND,VALIDATION
linode.disk.imagize
struct
DESCRIPTION Creates a gold-master image for future deployments
PARAMETERS
struct
Description
struct
DESCRIPTION An optional description of the created image
NAME Description
REQUIRED false
TYPE string
DiskID
struct
DESCRIPTION Specifies the source Disk to create the image from
NAME DiskID
REQUIRED true
TYPE numeric
Label
struct
DESCRIPTION Sets the name of the image shown in the base image list, defaults to the source image label
NAME Label
REQUIRED false
TYPE string
LinodeID
struct
DESCRIPTION Specifies the source Linode to create the image from
NAME LinodeID
REQUIRED true
TYPE numeric
THROWS [empty string]
linode.disk.list
struct
DESCRIPTION Status values are 1: Ready and 2: Being Deleted.
PARAMETERS
struct
DiskID
struct
DESCRIPTION [empty string]
NAME DiskID
REQUIRED false
TYPE numeric
LinodeID
struct
DESCRIPTION [empty string]
NAME LinodeID
REQUIRED true
TYPE numeric
THROWS [empty string]
linode.disk.resize
struct
DESCRIPTION [empty string]
PARAMETERS
struct
DiskID
struct
DESCRIPTION [empty string]
NAME DiskID
REQUIRED true
TYPE numeric
LinodeID
struct
DESCRIPTION [empty string]
NAME LinodeID
REQUIRED true
TYPE numeric
size
struct
DESCRIPTION The requested new size of this Disk in MB
NAME size
REQUIRED true
TYPE numeric
THROWS NOTFOUND,VALIDATION
linode.disk.update
struct
DESCRIPTION [empty string]
PARAMETERS
struct
DiskID
struct
DESCRIPTION [empty string]
NAME DiskID
REQUIRED true
TYPE numeric
Label
struct
DESCRIPTION The display label for this Disk
NAME Label
REQUIRED false
TYPE string
LinodeID
struct
DESCRIPTION [empty string]
NAME LinodeID
REQUIRED false
TYPE numeric
isReadOnly
struct
DESCRIPTION Enable forced read-only for this Disk
NAME isReadOnly
REQUIRED false
TYPE boolean
THROWS NOTFOUND,VALIDATION
linode.ip.addprivate
struct
DESCRIPTION Assigns a Private IP to a Linode. Returns the IPAddressID that was added.
PARAMETERS
struct
LinodeID
struct
DESCRIPTION [empty string]
NAME LinodeID
REQUIRED true
TYPE numeric
THROWS NOTFOUND
linode.ip.addpublic
struct
DESCRIPTION Assigns a Public IP to a Linode. Returns the IPAddressID and IPAddress that was added.
PARAMETERS
struct
LinodeID
struct
DESCRIPTION The LinodeID of the Linode that will be assigned an additional public IP address
NAME LinodeID
REQUIRED true
TYPE numeric
THROWS NOTFOUND,VALIDATION
linode.ip.list
struct
DESCRIPTION Returns the IP addresses of all Linodes you have access to.
PARAMETERS
struct
IPAddressID
struct
DESCRIPTION If specified, limits the result to this IPAddressID
NAME IPAddressID
REQUIRED false
TYPE numeric
LinodeID
struct
DESCRIPTION If specified, limits the result to this LinodeID
NAME LinodeID
REQUIRED false
TYPE numeric
THROWS NOTFOUND
linode.ip.setrdns
struct
DESCRIPTION Sets the rDNS name of a Public IP. Returns the IPAddressID and IPAddress that were updated.
PARAMETERS
struct
Hostname
struct
DESCRIPTION The hostname to set the reverse DNS to
NAME Hostname
REQUIRED true
TYPE string
IPAddressID
struct
DESCRIPTION The IPAddressID of the address to update
NAME IPAddressID
REQUIRED true
TYPE numeric
THROWS NOTFOUND,VALIDATION
linode.ip.swap
struct
DESCRIPTION Exchanges Public IP addresses between two Linodes within a Datacenter. The destination of the IP Address can be designated by either the toLinodeID or withIPAddressID parameter. Returns the resulting relationship of the Linode and IP Address parameters. When performing a one directional swap, the source is represented by the first of the two resultant array members.
PARAMETERS
struct
IPAddressID
struct
DESCRIPTION The IPAddressID of an IP Address to transfer or swap
NAME IPAddressID
REQUIRED true
TYPE numeric
toLinodeID
struct
DESCRIPTION The LinodeID of the Linode where IPAddressID will be transfered
NAME toLinodeID
REQUIRED false
TYPE numeric
withIPAddressID
struct
DESCRIPTION The IP Address ID to swap
NAME withIPAddressID
REQUIRED false
TYPE numeric
THROWS NOTFOUND,VALIDATION
linode.job.list
struct
DESCRIPTION [empty string]
PARAMETERS
struct
JobID
struct
DESCRIPTION Limits the list to the specified JobID
NAME JobID
REQUIRED false
TYPE numeric
LinodeID
struct
DESCRIPTION [empty string]
NAME LinodeID
REQUIRED true
TYPE numeric
pendingOnly
struct
DESCRIPTION [empty string]
NAME pendingOnly
REQUIRED false
TYPE boolean
THROWS [empty string]
linode.list
struct
DESCRIPTION Returns a list of all Linodes user has access or delete to, including some properties. Status values are -1: Being Created, 0: Brand New, 1: Running, and 2: Powered Off.
PARAMETERS
struct
LinodeID
struct
DESCRIPTION Limits the list to the specified LinodeID
NAME LinodeID
REQUIRED false
TYPE numeric
THROWS [empty string]
linode.mutate
struct
DESCRIPTION Upgrades a Linode to its next generation.
PARAMETERS
struct
LinodeID
struct
DESCRIPTION [empty string]
NAME LinodeID
REQUIRED true
TYPE numeric
THROWS NOTFOUND,VALIDATION
linode.reboot
struct
DESCRIPTION Issues a shutdown, and then boot job for a given LinodeID.
PARAMETERS
struct
ConfigID
struct
DESCRIPTION [empty string]
NAME ConfigID
REQUIRED false
TYPE numeric
LinodeID
struct
DESCRIPTION [empty string]
NAME LinodeID
REQUIRED true
TYPE numeric
THROWS NOTFOUND
linode.resize
struct
DESCRIPTION Resizes a Linode from one plan to another. Immediately shuts the Linode down, charges/credits the account, and issue a migration to another host server.
PARAMETERS
struct
LinodeID
struct
DESCRIPTION [empty string]
NAME LinodeID
REQUIRED true
TYPE numeric
PlanID
struct
DESCRIPTION The desired PlanID available from avail.LinodePlans()
NAME PlanID
REQUIRED true
TYPE numeric
THROWS NOTFOUND,CCFAILED,VALIDATION
linode.shutdown
struct
DESCRIPTION Issues a shutdown job for a given LinodeID.
PARAMETERS
struct
LinodeID
struct
DESCRIPTION [empty string]
NAME LinodeID
REQUIRED true
TYPE numeric
THROWS NOTFOUND
linode.update
struct
DESCRIPTION Updates a Linode's properties.
PARAMETERS
struct
Alert_bwin_enabled
struct
DESCRIPTION Enable the incoming bandwidth email alert
NAME Alert_bwin_enabled
REQUIRED false
TYPE boolean
Alert_bwin_threshold
struct
DESCRIPTION Mb/sec
NAME Alert_bwin_threshold
REQUIRED false
TYPE numeric
Alert_bwout_enabled
struct
DESCRIPTION Enable the outgoing bandwidth email alert
NAME Alert_bwout_enabled
REQUIRED false
TYPE boolean
Alert_bwout_threshold
struct
DESCRIPTION Mb/sec
NAME Alert_bwout_threshold
REQUIRED false
TYPE numeric
Alert_bwquota_enabled
struct
DESCRIPTION Enable the bw quote email alert
NAME Alert_bwquota_enabled
REQUIRED false
TYPE boolean
Alert_bwquota_threshold
struct
DESCRIPTION Percentage of monthly bw quota
NAME Alert_bwquota_threshold
REQUIRED false
TYPE numeric
Alert_cpu_enabled
struct
DESCRIPTION Enable the cpu usage email alert
NAME Alert_cpu_enabled
REQUIRED false
TYPE boolean
Alert_cpu_threshold
struct
DESCRIPTION CPU Alert threshold, percentage 0-800
NAME Alert_cpu_threshold
REQUIRED false
TYPE numeric
Alert_diskio_enabled
struct
DESCRIPTION Enable the disk IO email alert
NAME Alert_diskio_enabled
REQUIRED false
TYPE boolean
Alert_diskio_threshold
struct
DESCRIPTION IO ops/sec
NAME Alert_diskio_threshold
REQUIRED false
TYPE numeric
Label
struct
DESCRIPTION This Linode's label
NAME Label
REQUIRED false
TYPE string
LinodeID
struct
DESCRIPTION [empty string]
NAME LinodeID
REQUIRED true
TYPE numeric
backupWeeklyDay
struct
DESCRIPTION [empty string]
NAME backupWeeklyDay
REQUIRED false
TYPE numeric
backupWindow
struct
DESCRIPTION [empty string]
NAME backupWindow
REQUIRED false
TYPE numeric
lpm_displayGroup
struct
DESCRIPTION Display group in the Linode list inside the Linode Manager
NAME lpm_displayGroup
REQUIRED false
TYPE string
ms_ssh_disabled
struct
DESCRIPTION [empty string]
NAME ms_ssh_disabled
REQUIRED false
TYPE boolean
ms_ssh_ip
struct
DESCRIPTION [empty string]
NAME ms_ssh_ip
REQUIRED false
TYPE string
ms_ssh_port
struct
DESCRIPTION [empty string]
NAME ms_ssh_port
REQUIRED false
TYPE numeric
ms_ssh_user
struct
DESCRIPTION [empty string]
NAME ms_ssh_user
REQUIRED false
TYPE string
watchdog
struct
DESCRIPTION Enable the Lassie shutdown watchdog
NAME watchdog
REQUIRED false
TYPE boolean
THROWS NOTFOUND,VALIDATION
linode.webconsoletoken
struct
DESCRIPTION Generates a console token starting a web console LISH session for the requesting IP
PARAMETERS
struct
LinodeID
struct
DESCRIPTION [empty string]
NAME LinodeID
REQUIRED true
TYPE numeric
THROWS NOTFOUND,VALIDATION
nodebalancer.config.create
struct
DESCRIPTION [empty string]
PARAMETERS
struct
Algorithm
struct
DESCRIPTION Balancing algorithm. One of 'roundrobin', 'leastconn', 'source'
NAME Algorithm
REQUIRED false
TYPE string
default roundrobin
NodeBalancerID
struct
DESCRIPTION The parent NodeBalancer's ID
NAME NodeBalancerID
REQUIRED true
TYPE numeric
Port
struct
DESCRIPTION Port to bind to on the public interfaces. 1-65534
NAME Port
REQUIRED false
TYPE numeric
default 80
Protocol
struct
DESCRIPTION Either 'tcp', 'http', or 'https'
NAME Protocol
REQUIRED false
TYPE string
default http
Stickiness
struct
DESCRIPTION Session persistence. One of 'none', 'table', 'http_cookie'
NAME Stickiness
REQUIRED false
TYPE string
default table
check
struct
DESCRIPTION Perform active health checks on the backend nodes. One of 'connection', 'http', 'http_body'
NAME check
REQUIRED false
TYPE string
default connection
check_attempts
struct
DESCRIPTION Number of failed probes before taking a node out of rotation. 1-30
NAME check_attempts
REQUIRED false
TYPE string
default 2
check_body
struct
DESCRIPTION When check=http, a regex to match within the first 16,384 bytes of the response body
NAME check_body
REQUIRED false
TYPE string
default [empty string]
check_interval
struct
DESCRIPTION Seconds between health check probes. 2-3600
NAME check_interval
REQUIRED false
TYPE numeric
default 5
check_passive
struct
DESCRIPTION Enable passive checks based on observing communication with back-end nodes.
NAME check_passive
REQUIRED false
TYPE boolean
default 1
check_path
struct
DESCRIPTION When check=http, the path to request
NAME check_path
REQUIRED false
TYPE string
default /
check_timeout
struct
DESCRIPTION Seconds to wait before considering the probe a failure. 1-30. Must be less than check_interval.
NAME check_timeout
REQUIRED false
TYPE string
default 3
cipher_suite
struct
DESCRIPTION SSL cipher suite to enforce. One of 'recommended', 'legacy'
NAME cipher_suite
REQUIRED false
TYPE string
default recommended
ssl_cert
struct
DESCRIPTION SSL certificate served by the NodeBalancer when the protocol is 'https'
NAME ssl_cert
REQUIRED false
TYPE string
default [empty string]
ssl_key
struct
DESCRIPTION Unpassphrased private key for the SSL certificate when protocol is 'https'
NAME ssl_key
REQUIRED false
TYPE string
default [empty string]
THROWS NOTFOUND,VALIDATION
nodebalancer.config.delete
struct
DESCRIPTION Deletes a NodeBalancer's Config
PARAMETERS
struct
ConfigID
struct
DESCRIPTION The ConfigID to delete
NAME ConfigID
REQUIRED true
TYPE numeric
NodeBalancerID
struct
DESCRIPTION [empty string]
NAME NodeBalancerID
REQUIRED true
TYPE numeric
THROWS NOTFOUND
nodebalancer.config.list
struct
DESCRIPTION Returns a list of NodeBalancers this user has access or delete to, including their properties
PARAMETERS
struct
ConfigID
struct
DESCRIPTION Limits the list to the specified ConfigID
NAME ConfigID
REQUIRED false
TYPE numeric
NodeBalancerID
struct
DESCRIPTION [empty string]
NAME NodeBalancerID
REQUIRED true
TYPE numeric
THROWS [empty string]
nodebalancer.config.update
struct
DESCRIPTION Updates a Config's properties
PARAMETERS
struct
Algorithm
struct
DESCRIPTION Balancing algorithm. One of 'roundrobin', 'leastconn', 'source'
NAME Algorithm
REQUIRED false
TYPE string
ConfigID
struct
DESCRIPTION [empty string]
NAME ConfigID
REQUIRED true
TYPE numeric
Port
struct
DESCRIPTION Port to bind to on the public interfaces. 1-65534
NAME Port
REQUIRED false
TYPE numeric
Protocol
struct
DESCRIPTION Either 'tcp', 'http', or 'https'
NAME Protocol
REQUIRED false
TYPE string
Stickiness
struct
DESCRIPTION Session persistence. One of 'none', 'table', 'http_cookie'
NAME Stickiness
REQUIRED false
TYPE string
check
struct
DESCRIPTION Perform active health checks on the backend nodes. One of 'connection', 'http', 'http_body'
NAME check
REQUIRED false
TYPE string
check_attempts
struct
DESCRIPTION Number of failed probes before taking a node out of rotation. 1-30
NAME check_attempts
REQUIRED false
TYPE string
check_body
struct
DESCRIPTION When check=http, a regex to match within the first 16,384 bytes of the response body
NAME check_body
REQUIRED false
TYPE string
check_interval
struct
DESCRIPTION Seconds between health check probes. 2-3600
NAME check_interval
REQUIRED false
TYPE numeric
check_passive
struct
DESCRIPTION Enable passive checks based on observing communication with back-end nodes.
NAME check_passive
REQUIRED false
TYPE boolean
check_path
struct
DESCRIPTION When check=http, the path to request
NAME check_path
REQUIRED false
TYPE string
check_timeout
struct
DESCRIPTION Seconds to wait before considering the probe a failure. 1-30. Must be less than check_interval.
NAME check_timeout
REQUIRED false
TYPE string
cipher_suite
struct
DESCRIPTION SSL cipher suite to enforce. One of 'recommended', 'legacy'
NAME cipher_suite
REQUIRED false
TYPE string
ssl_cert
struct
DESCRIPTION SSL certificate served by the NodeBalancer when the protocol is 'https'
NAME ssl_cert
REQUIRED false
TYPE string
ssl_key
struct
DESCRIPTION Unpassphrased private key for the SSL certificate when protocol is 'https'
NAME ssl_key
REQUIRED false
TYPE string
THROWS NOTFOUND,VALIDATION
nodebalancer.create
struct
DESCRIPTION [empty string]
PARAMETERS
struct
ClientConnThrottle
struct
DESCRIPTION To help mitigate abuse, throttle connections per second, per client IP. 0 to disable. Max of 20.
NAME ClientConnThrottle
REQUIRED false
TYPE numeric
default 0
DatacenterID
struct
DESCRIPTION The DatacenterID from avail.datacenters() where you wish to place this new NodeBalancer
NAME DatacenterID
REQUIRED true
TYPE numeric
Label
struct
DESCRIPTION This NodeBalancer's label
NAME Label
REQUIRED false
TYPE string
default deflabel9000cakemix
THROWS NOACCESS,CCFAILED,VALIDATION
nodebalancer.delete
struct
DESCRIPTION Immediately removes a NodeBalancer from your account and issues a pro-rated credit back to your account, if applicable.
PARAMETERS
struct
NodeBalancerID
struct
DESCRIPTION The NodeBalancerID to delete
NAME NodeBalancerID
REQUIRED true
TYPE numeric
THROWS NOTFOUND
nodebalancer.list
struct
DESCRIPTION Returns a list of NodeBalancers this user has access or delete to, including their properties
PARAMETERS
struct
NodeBalancerID
struct
DESCRIPTION Limits the list to the specified NodeBalancerID
NAME NodeBalancerID
REQUIRED false
TYPE numeric
THROWS [empty string]
nodebalancer.node.create
struct
DESCRIPTION [empty string]
PARAMETERS
struct
Address
struct
DESCRIPTION The address:port combination used to communicate with this Node
NAME Address
REQUIRED true
TYPE string
ConfigID
struct
DESCRIPTION The parent ConfigID to attach this Node to
NAME ConfigID
REQUIRED true
TYPE numeric
Label
struct
DESCRIPTION This backend Node's label
NAME Label
REQUIRED true
TYPE string
Mode
struct
DESCRIPTION The connections mode for this node. One of 'accept', 'reject', or 'drain'
NAME Mode
REQUIRED false
TYPE string
default accept
Weight
struct
DESCRIPTION Load balancing weight, 1-255. Higher means more connections.
NAME Weight
REQUIRED false
TYPE numeric
default 100
THROWS NOTFOUND,VALIDATION
nodebalancer.node.delete
struct
DESCRIPTION Deletes a Node from a NodeBalancer Config
PARAMETERS
struct
NodeID
struct
DESCRIPTION The NodeID to delete
NAME NodeID
REQUIRED true
TYPE numeric
THROWS NOTFOUND
nodebalancer.node.list
struct
DESCRIPTION Returns a list of Nodes associated with a NodeBalancer Config
PARAMETERS
struct
ConfigID
struct
DESCRIPTION [empty string]
NAME ConfigID
REQUIRED true
TYPE numeric
NodeID
struct
DESCRIPTION Limits the list to the specified NodeID
NAME NodeID
REQUIRED false
TYPE numeric
THROWS [empty string]
nodebalancer.node.update
struct
DESCRIPTION Updates a Node's properties
PARAMETERS
struct
Address
struct
DESCRIPTION The address:port combination used to communicate with this Node
NAME Address
REQUIRED false
TYPE string
Label
struct
DESCRIPTION This backend Node's label
NAME Label
REQUIRED false
TYPE string
Mode
struct
DESCRIPTION The connections mode for this node. One of 'accept', 'reject', or 'drain'
NAME Mode
REQUIRED false
TYPE string
NodeID
struct
DESCRIPTION [empty string]
NAME NodeID
REQUIRED true
TYPE numeric
Weight
struct
DESCRIPTION Load balancing weight, 1-255. Higher means more connections.
NAME Weight
REQUIRED false
TYPE numeric
THROWS NOTFOUND,VALIDATION
nodebalancer.update
struct
DESCRIPTION Updates a NodeBalancer's properties
PARAMETERS
struct
ClientConnThrottle
struct
DESCRIPTION To help mitigate abuse, throttle connections per second, per client IP. 0 to disable. Max of 20.
NAME ClientConnThrottle
REQUIRED false
TYPE numeric
Label
struct
DESCRIPTION This NodeBalancer's label
NAME Label
REQUIRED false
TYPE string
NodeBalancerID
struct
DESCRIPTION [empty string]
NAME NodeBalancerID
REQUIRED true
TYPE numeric
THROWS NOTFOUND,VALIDATION
professionalservices.scope.create
struct
DESCRIPTION Creates a new Professional Services scope submission
PARAMETERS
struct
application_quantity
struct
DESCRIPTION How many separate applications or websites are involved in this migration?
NAME application_quantity
REQUIRED false
TYPE string
default [empty string]
content_management
struct
DESCRIPTION Centralized interfaces for editing, organizing, and publishing content
NAME content_management
REQUIRED false
TYPE string
default [empty string]
crossover
struct
DESCRIPTION These can assist in providing reliable crossover--failures of individual components can be transparent to the application.
NAME crossover
REQUIRED false
TYPE string
default [empty string]
current_provider
struct
DESCRIPTION [empty string]
NAME current_provider
REQUIRED false
TYPE string
default [empty string]
customer_name
struct
DESCRIPTION [empty string]
NAME customer_name
REQUIRED false
TYPE string
default [empty string]
database_server
struct
DESCRIPTION Generally used by applications to provide an organized way to capture and manipulate data
NAME database_server
REQUIRED false
TYPE string
default [empty string]
email_address
struct
DESCRIPTION [empty string]
NAME email_address
REQUIRED false
TYPE string
default [empty string]
linode_datacenter
struct
DESCRIPTION Which datacenters would you like your Linodes to be deployed in?
NAME linode_datacenter
REQUIRED false
TYPE string
default [empty string]
linode_plan
struct
DESCRIPTION Which Linode plans would you like to deploy?
NAME linode_plan
REQUIRED false
TYPE string
default [empty string]
mail_filtering
struct
DESCRIPTION Services here manipulate recieved messages in various ways
NAME mail_filtering
REQUIRED false
TYPE string
default [empty string]
mail_retrieval
struct
DESCRIPTION User mail clients connect to these to retrieve delivered mail
NAME mail_retrieval
REQUIRED false
TYPE string
default [empty string]
mail_transfer
struct
DESCRIPTION Mail transfer agents facilitate message transfer between servers
NAME mail_transfer
REQUIRED false
TYPE string
default [empty string]
managed
struct
DESCRIPTION [empty string]
NAME managed
REQUIRED false
TYPE string
default [empty string]
monitoring
struct
DESCRIPTION Constant monitoring of your deployed systems--these can also provide automatic notifications for service failures.
NAME monitoring
REQUIRED false
TYPE string
default [empty string]
notes
struct
DESCRIPTION [empty string]
NAME notes
REQUIRED false
TYPE string
default [empty string]
phone_number
struct
DESCRIPTION [empty string]
NAME phone_number
REQUIRED false
TYPE string
default [empty string]
provider_access
struct
DESCRIPTION What types of server access do you have at your current provider?
NAME provider_access
REQUIRED false
TYPE string
default [empty string]
replication
struct
DESCRIPTION Redundant services often have shared state--replication automatically propagates state changes between individual components.
NAME replication
REQUIRED false
TYPE string
default [empty string]
requested_service
struct
DESCRIPTION [empty string]
NAME requested_service
REQUIRED false
TYPE string
default [empty string]
server_quantity
struct
DESCRIPTION How many separate servers are involved in this migration?
NAME server_quantity
REQUIRED false
TYPE string
default [empty string]
system_administration
struct
DESCRIPTION Various web interfaces for performing system administration tasks
NAME system_administration
REQUIRED false
TYPE string
default [empty string]
ticket_number
struct
DESCRIPTION [empty string]
NAME ticket_number
REQUIRED false
TYPE string
default [empty string]
web_cache
struct
DESCRIPTION Caching mechanisms provide temporary storage for web requests--cached content can generally be retrieved faster.
NAME web_cache
REQUIRED false
TYPE string
default [empty string]
web_server
struct
DESCRIPTION These provide network protocol handling for hosting websites.
NAME web_server
REQUIRED false
TYPE string
default [empty string]
webmail
struct
DESCRIPTION Access and administrate mail via web interfaces
NAME webmail
REQUIRED false
TYPE string
default [empty string]
THROWS [empty string]
stackscript.create
struct
DESCRIPTION Create a StackScript.
PARAMETERS
struct
Description
struct
DESCRIPTION [empty string]
NAME Description
REQUIRED false
TYPE string
default [empty string]
DistributionIDList
struct
DESCRIPTION Comma delimited list of DistributionIDs that this script works on
NAME DistributionIDList
REQUIRED true
TYPE string
Label
struct
DESCRIPTION The Label for this StackScript
NAME Label
REQUIRED true
TYPE string
isPublic
struct
DESCRIPTION Whether this StackScript is published in the Library, for everyone to use
NAME isPublic
REQUIRED false
TYPE boolean
default false
rev_note
struct
DESCRIPTION [empty string]
NAME rev_note
REQUIRED false
TYPE string
default [empty string]
script
struct
DESCRIPTION The actual script
NAME script
REQUIRED true
TYPE string
THROWS NOACCESS,VALIDATION
stackscript.delete
struct
DESCRIPTION [empty string]
PARAMETERS
struct
StackScriptID
struct
DESCRIPTION [empty string]
NAME StackScriptID
REQUIRED true
TYPE numeric
THROWS NOTFOUND
stackscript.list
struct
DESCRIPTION Lists StackScripts you have access to.
PARAMETERS
struct
StackScriptID
struct
DESCRIPTION Limits the list to the specified StackScriptID
NAME StackScriptID
REQUIRED false
TYPE numeric
THROWS [empty string]
stackscript.update
struct
DESCRIPTION Update a StackScript.
PARAMETERS
struct
Description
struct
DESCRIPTION [empty string]
NAME Description
REQUIRED false
TYPE string
DistributionIDList
struct
DESCRIPTION Comma delimited list of DistributionIDs that this script works on
NAME DistributionIDList
REQUIRED false
TYPE string
Label
struct
DESCRIPTION The Label for this StackScript
NAME Label
REQUIRED false
TYPE string
StackScriptID
struct
DESCRIPTION [empty string]
NAME StackScriptID
REQUIRED true
TYPE numeric
isPublic
struct
DESCRIPTION Whether this StackScript is published in the Library, for everyone to use
NAME isPublic
REQUIRED false
TYPE boolean
rev_note
struct
DESCRIPTION [empty string]
NAME rev_note
REQUIRED false
TYPE string
script
struct
DESCRIPTION The actual script
NAME script
REQUIRED false
TYPE string
THROWS NOTFOUND,VALIDATION
test.echo
struct
DESCRIPTION Echos back parameters that were passed in.
PARAMETERS
struct [empty]
THROWS [empty string]
user.getapikey
struct
DESCRIPTION Authenticates a Linode Manager user against their username, password, and two-factor token (when enabled), and then returns a new API key, which can be used until it expires. The number of active keys is limited to 20.
PARAMETERS
struct
expires
struct
DESCRIPTION Number of hours the key will remain valid, between 0 and 8760. 0 means no expiration. Defaults to 168.
NAME expires
REQUIRED false
TYPE numeric
label
struct
DESCRIPTION An optional label for this key.
NAME label
REQUIRED false
TYPE string
password
struct
DESCRIPTION [empty string]
NAME password
REQUIRED true
TYPE string
token
struct
DESCRIPTION Required when two-factor authentication is enabled.
NAME token
REQUIRED false
TYPE string
username
struct
DESCRIPTION [empty string]
NAME username
REQUIRED true
TYPE string
THROWS AUTHFAIL,NEEDTOKEN,PASSWORDEXPIRED,KEYLIMIT
VERSION 3.3
ERRORARRAY
array [empty]