Module: LinodeAPI

Defined in:

lib/linodeapi.rb,
lib/linodeapi/api.rb,
lib/linodeapi/raw.rb,
lib/linodeapi/spec.rb

Overview

Dynamically updated spec from the api.spec call rubocop:disable all

Defined Under Namespace

Classes: API, Raw

Constant Summary

DEFAULT_ENDPOINT =

Default API endpoint

'https://api.linode.com/'

SPEC =

{:type=>"group",
 :subs=>
  {:account=>
    {:type=>:group,
     :subs=>
      {:estimateinvoice=>
        {:type=>:call,
         :desc=>
          "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",
         :throws=>["VALIDATION"],
         :params=>
          {:linodeid=>
 {:desc=>
   "This is the LinodeID you want to resize and is required for mode 'linode_resize'.",
  :type=>:numeric,
  :required=>false},
:paymentterm=>
 {:desc=>
   "Subscription term in months. One of: 1, 12, or 24. This is required for modes 'linode_new' and 'nodebalancer_new'.",
  :type=>:numeric,
  :required=>false},
:planid=>
 {:desc=>
   "The desired PlanID available from avail.LinodePlans(). This is required for modes 'linode_new' and 'linode_resize'.",
  :type=>:numeric,
  :required=>false},
:mode=>
 {:desc=>
   "This is one of the following options: 'linode_new', 'linode_resize', or 'nodebalancer_new'.",
  :type=>:string,
  :required=>true}}},
       :info=>
        {:type=>:call,
         :desc=>
          "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.",
         :throws=>[],
         :params=>{}},
       :paybalance=>
        {:type=>:call,
         :desc=>"Pays current balance on file, returning it in the response.",
         :throws=>
          ["CCEXPIRED",
"CCFAILED",
"NOACCESS",
"PAYMENTLIMITER",
"VALIDATION"],
         :params=>{}},
       :updatecard=>
        {:type=>:call,
         :desc=>"",
         :throws=>[],
         :params=>
          {:ccexpmonth=>{:desc=>"", :type=>:numeric, :required=>true},
:ccexpyear=>{:desc=>"", :type=>:numeric, :required=>true},
:ccnumber=>{:desc=>"", :type=>:numeric, :required=>true}}}}},
   :api=>
    {:type=>:group,
     :subs=>
      {:spec=>
        {:type=>:call,
         :desc=>
          "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>",
         :throws=>[],
         :params=>{}}}},
   :avail=>
    {:type=>:group,
     :subs=>
      {:datacenters=>
        {:type=>:call,
         :desc=>"Returns a list of Linode data center facilities.",
         :throws=>[],
         :params=>{}},
       :distributions=>
        {:type=>:call,
         :desc=>"Returns a list of available Linux Distributions.",
         :throws=>[],
         :params=>
          {:distributionid=>
 {:desc=>"Limits the results to the specified DistributionID",
  :type=>:numeric,
  :required=>false}}},
       :kernels=>
        {:type=>:call,
         :desc=>"List available kernels.",
         :throws=>[],
         :params=>
          {:kernelid=>{:desc=>"", :type=>:numeric, :required=>false},
:isxen=>
 {:desc=>"Limits the results to show only Xen kernels",
  :type=>:boolean,
  :required=>false}}},
       :linodeplans=>
        {:type=>:call,
         :desc=>
          "Returns a structure of Linode PlanIDs containing the Plan label and the availability in each Datacenter.",
         :throws=>[],
         :params=>
          {:planid=>
 {:desc=>"Limits the list to the specified PlanID",
  :type=>:numeric,
  :required=>false}}},
       :nodebalancers=>
        {:type=>:call,
         :desc=>"Returns NodeBalancer pricing information.",
         :throws=>[],
         :params=>{}},
       :stackscripts=>
        {:type=>:call,
         :desc=>"Returns a list of available public StackScripts.",
         :throws=>[],
         :params=>
          {:distributionid=>
 {:desc=>
   "Limit the results to StackScripts that can be applied to this DistributionID",
  :type=>:numeric,
  :required=>false},
:distributionvendor=>
 {:desc=>"Debian, Ubuntu, Fedora, etc.",
  :type=>:string,
  :required=>false},
:keywords=>
 {:desc=>"Search terms", :type=>:string, :required=>false}}}}},
   :domain=>
    {:type=>:group,
     :subs=>
      {:create=>
        {:type=>:call,
         :desc=>"Create a domain record.",
         :throws=>["NOACCESS", "VALIDATION"],
         :params=>
          {:description=>
 {:desc=>"Currently undisplayed.",
  :type=>:string,
  :required=>false},
:domain=>
 {:desc=>"The zone's name", :type=>:string, :required=>true},
:expire_sec=>{:desc=>"", :type=>:numeric, :required=>false},
:refresh_sec=>{:desc=>"", :type=>:numeric, :required=>false},
:retry_sec=>{:desc=>"", :type=>:numeric, :required=>false},
:soa_email=>
 {:desc=>"Required when type=master",
  :type=>:string,
  :required=>false},
:ttl_sec=>{:desc=>"", :type=>:numeric, :required=>false},
:type=>{:desc=>"master or slave", :type=>:string, :required=>true},
:axfr_ips=>
 {:desc=>
   "IP addresses allowed to AXFR the entire zone, semicolon separated",
  :type=>:string,
  :required=>false},
:lpm_displaygroup=>
 {:desc=>
   "Display group in the Domain list inside the Linode DNS Manager",
  :type=>:string,
  :required=>false},
:master_ips=>
 {:desc=>
   "When type=slave, the zone's master DNS servers list, semicolon separated ",
  :type=>:string,
  :required=>false},
:status=>
 {:desc=>"0, 1, or 2 (disabled, active, edit mode)",
  :type=>:numeric,
  :required=>false}}},
       :delete=>
        {:type=>:call,
         :desc=>"",
         :throws=>["NOTFOUND"],
         :params=>{:domainid=>{:desc=>"", :type=>:numeric, :required=>true}}},
       :list=>
        {:type=>:call,
         :desc=>"Lists domains you have access to.",
         :throws=>[],
         :params=>
          {:domainid=>
 {:desc=>"Limits the list to the specified DomainID",
  :type=>:numeric,
  :required=>false}}},
       :resource=>
        {:type=>:group,
         :subs=>
          {:create=>
 {:type=>:call,
  :desc=>"Create a domain record.",
  :throws=>["NOACCESS", "VALIDATION"],
  :params=>
   {:domainid=>{:desc=>"", :type=>:numeric, :required=>true},
    :name=>
     {:desc=>
       "The hostname or FQDN.  When Type=MX the subdomain to delegate to the Target MX server.",
      :type=>:string,
      :required=>false},
    :port=>{:desc=>"", :type=>:numeric, :required=>false},
    :priority=>
     {:desc=>"Priority for MX and SRV records, 0-255",
      :type=>:numeric,
      :required=>false},
    :protocol=>
     {:desc=>
       "The protocol to append to an SRV record.  Ignored on other record types.",
      :type=>:string,
      :required=>false},
    :ttl_sec=>
     {:desc=>"TTL.  Leave as 0 to accept our default.",
      :type=>:numeric,
      :required=>false},
    :target=>
     {:desc=>
       "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.",
      :type=>:string,
      :required=>false},
    :type=>
     {:desc=>"One of: NS, MX, A, AAAA, CNAME, TXT, or SRV",
      :type=>:string,
      :required=>true},
    :weight=>{:desc=>"", :type=>:numeric, :required=>false}}},
:delete=>
 {:type=>:call,
  :desc=>"",
  :throws=>["NOTFOUND"],
  :params=>
   {:domainid=>{:desc=>"", :type=>:numeric, :required=>true},
    :resourceid=>{:desc=>"", :type=>:numeric, :required=>true}}},
:list=>
 {:type=>:call,
  :desc=>"",
  :throws=>[],
  :params=>
   {:domainid=>{:desc=>"", :type=>:numeric, :required=>true},
    :resourceid=>{:desc=>"", :type=>:numeric, :required=>false}}},
:update=>
 {:type=>:call,
  :desc=>"Update a domain record.",
  :throws=>["NOTFOUND", "VALIDATION"],
  :params=>
   {:domainid=>{:desc=>"", :type=>:numeric, :required=>false},
    :name=>
     {:desc=>
       "The hostname or FQDN.  When Type=MX the subdomain to delegate to the Target MX server.",
      :type=>:string,
      :required=>false},
    :port=>{:desc=>"", :type=>:numeric, :required=>false},
    :priority=>
     {:desc=>"Priority for MX and SRV records, 0-255",
      :type=>:numeric,
      :required=>false},
    :protocol=>
     {:desc=>
       "The protocol to append to an SRV record.  Ignored on other record types.",
      :type=>:string,
      :required=>false},
    :resourceid=>{:desc=>"", :type=>:numeric, :required=>true},
    :ttl_sec=>
     {:desc=>"TTL.  Leave as 0 to accept our default.",
      :type=>:numeric,
      :required=>false},
    :target=>
     {:desc=>
       "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.",
      :type=>:string,
      :required=>false},
    :weight=>{:desc=>"", :type=>:numeric, :required=>false}}}}},
       :update=>
        {:type=>:call,
         :desc=>"Update a domain record.",
         :throws=>["NOTFOUND", "VALIDATION"],
         :params=>
          {:description=>
 {:desc=>"Currently undisplayed.",
  :type=>:string,
  :required=>false},
:domain=>
 {:desc=>"The zone's name", :type=>:string, :required=>false},
:domainid=>{:desc=>"", :type=>:numeric, :required=>true},
:expire_sec=>{:desc=>"", :type=>:numeric, :required=>false},
:refresh_sec=>{:desc=>"", :type=>:numeric, :required=>false},
:retry_sec=>{:desc=>"", :type=>:numeric, :required=>false},
:soa_email=>
 {:desc=>"Required when type=master",
  :type=>:string,
  :required=>false},
:ttl_sec=>{:desc=>"", :type=>:numeric, :required=>false},
:type=>{:desc=>"master or slave", :type=>:string, :required=>false},
:axfr_ips=>
 {:desc=>
   "IP addresses allowed to AXFR the entire zone, semicolon separated",
  :type=>:string,
  :required=>false},
:lpm_displaygroup=>
 {:desc=>
   "Display group in the Domain list inside the Linode DNS Manager",
  :type=>:string,
  :required=>false},
:master_ips=>
 {:desc=>
   "When type=slave, the zone's master DNS servers list, semicolon separated ",
  :type=>:string,
  :required=>false},
:status=>
 {:desc=>"0, 1, or 2 (disabled, active, edit mode)",
  :type=>:numeric,
  :required=>false}}}}},
   :image=>
    {:type=>:group,
     :subs=>
      {:delete=>
        {:type=>:call,
         :desc=>"Deletes a gold-master image",
         :throws=>["NOTFOUND"],
         :params=>
          {:imageid=>
 {:desc=>"The ID of the gold-master image to delete",
  :type=>:numeric,
  :required=>true}}},
       :list=>
        {:type=>:call,
         :desc=>"Lists available gold-master images",
         :throws=>["NOTFOUND"],
         :params=>
          {:imageid=>
 {:desc=>"Request information for a specific gold-master image",
  :type=>:numeric,
  :required=>false},
:pending=>
 {:desc=>"Show images currently being created.",
  :type=>:numeric,
  :required=>false}}},
       :update=>
        {:type=>:call,
         :desc=>"Update an Image record.",
         :throws=>["NOTFOUND", "VALIDATION"],
         :params=>
          {:imageid=>
 {:desc=>"The ID of the Image to modify.",
  :type=>:numeric,
  :required=>true},
:description=>
 {:desc=>"An optional description of the Image.",
  :type=>:string,
  :required=>false},
:label=>
 {:desc=>"The label of the Image.",
  :type=>:string,
  :required=>false}}}}},
   :linode=>
    {:type=>:group,
     :subs=>
      {:boot=>
        {:type=>:call,
         :desc=>
          "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.",
         :throws=>["NOTFOUND"],
         :params=>
          {:configid=>
 {:desc=>
   "The ConfigID to boot, available from linode.config.list().",
  :type=>:numeric,
  :required=>false},
:linodeid=>{:desc=>"", :type=>:numeric, :required=>true}}},
       :clone=>
        {:type=>:call,
         :desc=>
          "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.",
         :throws=>
          ["NOACCESS",
"NOTFOUND",
"CCFAILED",
"VALIDATION",
"LINODELIMITER",
"ACCOUNTLIMIT"],
         :params=>
          {:datacenterid=>
 {:desc=>
   "The DatacenterID from avail.datacenters() where you wish to place this new Linode",
  :type=>:numeric,
  :required=>true},
:linodeid=>
 {:desc=>"The LinodeID that you want cloned",
  :type=>:numeric,
  :required=>true},
:paymentterm=>
 {:desc=>
   "Subscription term in months for prepaid customers.  One of: 1, 12, or 24",
  :type=>:numeric,
  :required=>false},
:planid=>
 {:desc=>"The desired PlanID available from avail.LinodePlans()",
  :type=>:numeric,
  :required=>true}}},
       :config=>
        {:type=>:group,
         :subs=>
          {:create=>
 {:type=>:call,
  :desc=>"Creates a Linode Configuration Profile.",
  :throws=>["NOTFOUND", "VALIDATION"],
  :params=>
   {:comments=>
     {:desc=>"Comments you wish to save along with this profile",
      :type=>:string,
      :required=>false},
    :disklist=>
     {:desc=>
       "A comma delimited list of DiskIDs; position reflects device node.  The 9th element for specifying the initrd.",
      :type=>:string,
      :required=>true},
    :kernelid=>
     {:desc=>
       "The KernelID for this profile.  Found in avail.kernels()",
      :type=>:numeric,
      :required=>true},
    :label=>
     {:desc=>"The Label for this profile",
      :type=>:string,
      :required=>true},
    :linodeid=>{:desc=>"", :type=>:numeric, :required=>true},
    :ramlimit=>
     {:desc=>"RAMLimit in MB.  0 for max.",
      :type=>:numeric,
      :required=>false},
    :rootdevicecustom=>
     {:desc=>"A custom root device setting.",
      :type=>:string,
      :required=>false},
    :rootdevicenum=>
     {:desc=>
       "Which device number (1-8) that contains the root partition.  0 to utilize RootDeviceCustom.",
      :type=>:numeric,
      :required=>false},
    :rootdevicero=>
     {:desc=>
       "Enables the 'ro' kernel flag.  Modern distros want this. ",
      :type=>:boolean,
      :required=>false},
    :runlevel=>
     {:desc=>"One of 'default', 'single', 'binbash' ",
      :type=>:string,
      :required=>false},
    :devtmpfs_automount=>
     {:desc=>
       "Controls if pv_ops kernels should automount devtmpfs at boot. ",
      :type=>:boolean,
      :required=>false},
    :helper_depmod=>
     {:desc=>
       "Creates an empty modprobe file for the kernel you're booting. ",
      :type=>:boolean,
      :required=>false},
    :helper_disableupdatedb=>
     {:desc=>"Enable the disableUpdateDB filesystem helper",
      :type=>:boolean,
      :required=>false},
    :helper_network=>
     {:desc=>
       "Automatically creates network configuration files for your distro and places them into your filesystem.",
      :type=>:boolean,
      :required=>false},
    :helper_xen=>
     {:desc=>
       "Enable the Xen filesystem helper.  Corrects fstab and inittab/upstart entries depending on the kernel you're booting.  You want this.",
      :type=>:boolean,
      :required=>false}}},
:delete=>
 {:type=>:call,
  :desc=>"Deletes a Linode Configuration Profile.",
  :throws=>["NOTFOUND", "VALIDATION"],
  :params=>
   {:configid=>{:desc=>"", :type=>:numeric, :required=>true},
    :linodeid=>{:desc=>"", :type=>:numeric, :required=>true}}},
:list=>
 {:type=>:call,
  :desc=>"Lists a Linode's Configuration Profiles.",
  :throws=>["NOTFOUND"],
  :params=>
   {:configid=>{:desc=>"", :type=>:numeric, :required=>false},
    :linodeid=>{:desc=>"", :type=>:numeric, :required=>true}}},
:update=>
 {:type=>:call,
  :desc=>"Updates a Linode Configuration Profile.",
  :throws=>["NOTFOUND", "VALIDATION"],
  :params=>
   {:comments=>
     {:desc=>"Comments you wish to save along with this profile",
      :type=>:string,
      :required=>false},
    :configid=>{:desc=>"", :type=>:numeric, :required=>true},
    :disklist=>
     {:desc=>
       "A comma delimited list of DiskIDs; position reflects device node.  The 9th element for specifying the initrd.",
      :type=>:string,
      :required=>false},
    :kernelid=>
     {:desc=>
       "The KernelID for this profile.  Found in avail.kernels()",
      :type=>:numeric,
      :required=>false},
    :label=>
     {:desc=>"The Label for this profile",
      :type=>:string,
      :required=>false},
    :linodeid=>{:desc=>"", :type=>:numeric, :required=>false},
    :ramlimit=>
     {:desc=>"RAMLimit in MB.  0 for max.",
      :type=>:numeric,
      :required=>false},
    :rootdevicecustom=>
     {:desc=>"A custom root device setting.",
      :type=>:string,
      :required=>false},
    :rootdevicenum=>
     {:desc=>
       "Which device number (1-8) that contains the root partition.  0 to utilize RootDeviceCustom.",
      :type=>:numeric,
      :required=>false},
    :rootdevicero=>
     {:desc=>
       "Enables the 'ro' kernel flag.  Modern distros want this. ",
      :type=>:boolean,
      :required=>false},
    :runlevel=>
     {:desc=>"One of 'default', 'single', 'binbash' ",
      :type=>:string,
      :required=>false},
    :devtmpfs_automount=>
     {:desc=>
       "Controls if pv_ops kernels should automount devtmpfs at boot. ",
      :type=>:boolean,
      :required=>false},
    :helper_depmod=>
     {:desc=>
       "Creates an empty modprobe file for the kernel you're booting. ",
      :type=>:boolean,
      :required=>false},
    :helper_disableupdatedb=>
     {:desc=>"Enable the disableUpdateDB filesystem helper",
      :type=>:boolean,
      :required=>false},
    :helper_network=>
     {:desc=>
       "Automatically creates network configuration files for your distro and places them into your filesystem.",
      :type=>:boolean,
      :required=>false},
    :helper_xen=>
     {:desc=>
       "Enable the Xen filesystem helper.  Corrects fstab and inittab/upstart entries depending on the kernel you're booting.  You want this.",
      :type=>:boolean,
      :required=>false}}}}},
       :create=>
        {:type=>:call,
         :desc=>
          "Creates a Linode and assigns you full privileges. There is a 75-linodes-per-hour limiter.",
         :throws=>
          ["NOACCESS",
"CCFAILED",
"VALIDATION",
"LINODELIMITER",
"ACCOUNTLIMIT"],
         :params=>
          {:datacenterid=>
 {:desc=>
   "The DatacenterID from avail.datacenters() where you wish to place this new Linode",
  :type=>:numeric,
  :required=>true},
:paymentterm=>
 {:desc=>
   "Subscription term in months for prepaid customers.  One of: 1, 12, or 24",
  :type=>:numeric,
  :required=>false},
:planid=>
 {:desc=>"The desired PlanID available from avail.LinodePlans()",
  :type=>:numeric,
  :required=>true}}},
       :delete=>
        {:type=>:call,
         :desc=>
          "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.\"",
         :throws=>["NOTFOUND", "LINODENOTEMPTY"],
         :params=>
          {:linodeid=>
 {:desc=>"The LinodeID to delete",
  :type=>:numeric,
  :required=>true},
:skipchecks=>
 {:desc=>
   "Skips the safety checks and will always delete the Linode",
  :type=>:boolean,
  :required=>false}}},
       :disk=>
        {:type=>:group,
         :subs=>
          {:create=>
 {:type=>:call,
  :desc=>"",
  :throws=>["NOTFOUND", "VALIDATION"],
  :params=>
   {:fromdistributionid=>
     {:desc=>"", :type=>:numeric, :required=>false},
    :label=>
     {:desc=>"The display label for this Disk",
      :type=>:string,
      :required=>true},
    :linodeid=>{:desc=>"", :type=>:numeric, :required=>true},
    :size=>
     {:desc=>"The size in MB of this Disk.",
      :type=>:numeric,
      :required=>true},
    :type=>
     {:desc=>
       "The formatted type of this disk.  Valid types are: ext3, ext4, swap, raw",
      :type=>:string,
      :required=>true},
    :isreadonly=>
     {:desc=>"Enable forced read-only for this Disk",
      :type=>:boolean,
      :required=>false},
    :rootpass=>{:desc=>"", :type=>:string, :required=>false},
    :rootsshkey=>{:desc=>"", :type=>:string, :required=>false}}},
:createfromdistribution=>
 {:type=>:call,
  :desc=>"",
  :throws=>["NOTFOUND", "VALIDATION"],
  :params=>
   {:distributionid=>
     {:desc=>
       "The DistributionID to create this disk from.  Found in avail.distributions()",
      :type=>:numeric,
      :required=>true},
    :label=>
     {:desc=>"The label of this new disk image",
      :type=>:string,
      :required=>true},
    :linodeid=>{:desc=>"", :type=>:numeric, :required=>true},
    :size=>
     {:desc=>"Size of this disk image in MB",
      :type=>:numeric,
      :required=>true},
    :rootpass=>
     {:desc=>"The root user's password",
      :type=>:string,
      :required=>true},
    :rootsshkey=>
     {:desc=>
       "Optionally sets this string into /root/.ssh/authorized_keys upon distribution configuration.",
      :type=>:string,
      :required=>false}}},
:createfromimage=>
 {:type=>:call,
  :desc=>"Creates a new disk from a previously imagized disk.",
  :throws=>[],
  :params=>
   {:imageid=>
     {:desc=>"The ID of the frozen image to deploy from",
      :type=>:numeric,
      :required=>true},
    :label=>
     {:desc=>"The label of this new disk image",
      :type=>:string,
      :required=>false},
    :linodeid=>
     {:desc=>"Specifies the Linode to deploy on to",
      :type=>:numeric,
      :required=>true},
    :rootpass=>
     {:desc=>
       "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",
      :type=>:string,
      :required=>false},
    :rootsshkey=>
     {:desc=>
       "Optionally sets this string into /root/.ssh/authorized_keys upon image deployment",
      :type=>:string,
      :required=>false},
    :size=>
     {:desc=>
       "The size of the disk image to creates. Defaults to the minimum size required for the requested image",
      :type=>:numeric,
      :required=>false}}},
:createfromstackscript=>
 {:type=>:call,
  :desc=>"",
  :throws=>["NOTFOUND", "VALIDATION"],
  :params=>
   {:distributionid=>
     {:desc=>
       "Which Distribution to apply this StackScript to.  Must be one from the script's DistributionIDList",
      :type=>:numeric,
      :required=>true},
    :label=>
     {:desc=>"The label of this new disk image",
      :type=>:string,
      :required=>true},
    :linodeid=>{:desc=>"", :type=>:numeric, :required=>true},
    :size=>
     {:desc=>"Size of this disk image in MB",
      :type=>:numeric,
      :required=>true},
    :stackscriptid=>
     {:desc=>"The StackScript to create this image from",
      :type=>:numeric,
      :required=>true},
    :stackscriptudfresponses=>
     {:desc=>
       "JSON encoded name/value pairs, answering this StackScript's User Defined Fields",
      :type=>:string,
      :required=>true},
    :rootpass=>
     {:desc=>"The root user's password",
      :type=>:string,
      :required=>true},
    :rootsshkey=>
     {:desc=>
       "Optionally sets this string into /root/.ssh/authorized_keys upon distribution configuration.",
      :type=>:string,
      :required=>false}}},
:delete=>
 {:type=>:call,
  :desc=>"",
  :throws=>["NOTFOUND", "VALIDATION"],
  :params=>
   {:diskid=>{:desc=>"", :type=>:numeric, :required=>true},
    :linodeid=>{:desc=>"", :type=>:numeric, :required=>true}}},
:duplicate=>
 {:type=>:call,
  :desc=>"Performs a bit-for-bit copy of a disk image.",
  :throws=>["NOTFOUND", "VALIDATION"],
  :params=>
   {:diskid=>{:desc=>"", :type=>:numeric, :required=>true},
    :linodeid=>{:desc=>"", :type=>:numeric, :required=>true}}},
:imagize=>
 {:type=>:call,
  :desc=>"Creates a gold-master image for future deployments",
  :throws=>[],
  :params=>
   {:description=>
     {:desc=>"An optional description of the created image",
      :type=>:string,
      :required=>false},
    :diskid=>
     {:desc=>"Specifies the source Disk to create the image from",
      :type=>:numeric,
      :required=>true},
    :label=>
     {:desc=>
       "Sets the name of the image shown in the base image list, defaults to the source image label",
      :type=>:string,
      :required=>false},
    :linodeid=>
     {:desc=>"Specifies the source Linode to create the image from",
      :type=>:numeric,
      :required=>true}}},
:list=>
 {:type=>:call,
  :desc=>"Status values are 1: Ready and 2: Being Deleted.",
  :throws=>[],
  :params=>
   {:diskid=>{:desc=>"", :type=>:numeric, :required=>false},
    :linodeid=>{:desc=>"", :type=>:numeric, :required=>true}}},
:resize=>
 {:type=>:call,
  :desc=>"",
  :throws=>["NOTFOUND", "VALIDATION"],
  :params=>
   {:diskid=>{:desc=>"", :type=>:numeric, :required=>true},
    :linodeid=>{:desc=>"", :type=>:numeric, :required=>true},
    :size=>
     {:desc=>"The requested new size of this Disk in MB",
      :type=>:numeric,
      :required=>true}}},
:update=>
 {:type=>:call,
  :desc=>"",
  :throws=>["NOTFOUND", "VALIDATION"],
  :params=>
   {:diskid=>{:desc=>"", :type=>:numeric, :required=>true},
    :label=>
     {:desc=>"The display label for this Disk",
      :type=>:string,
      :required=>false},
    :linodeid=>{:desc=>"", :type=>:numeric, :required=>false},
    :isreadonly=>
     {:desc=>"Enable forced read-only for this Disk",
      :type=>:boolean,
      :required=>false}}}}},
       :ip=>
        {:type=>:group,
         :subs=>
          {:addprivate=>
 {:type=>:call,
  :desc=>
   "Assigns a Private IP to a Linode.  Returns the IPAddressID that was added.",
  :throws=>["NOTFOUND"],
  :params=>
   {:linodeid=>{:desc=>"", :type=>:numeric, :required=>true}}},
:addpublic=>
 {:type=>:call,
  :desc=>
   "Assigns a Public IP to a Linode.  Returns the IPAddressID and IPAddress that was added.",
  :throws=>["NOTFOUND", "VALIDATION"],
  :params=>
   {:linodeid=>
     {:desc=>
       "The LinodeID of the Linode that will be assigned an additional public IP address",
      :type=>:numeric,
      :required=>true}}},
:list=>
 {:type=>:call,
  :desc=>
   "Returns the IP addresses of all Linodes you have access to.",
  :throws=>["NOTFOUND"],
  :params=>
   {:ipaddressid=>
     {:desc=>"If specified, limits the result to this IPAddressID",
      :type=>:numeric,
      :required=>false},
    :linodeid=>
     {:desc=>"If specified, limits the result to this LinodeID",
      :type=>:numeric,
      :required=>false}}},
:setrdns=>
 {:type=>:call,
  :desc=>
   "Sets the rDNS name of a Public IP.  Returns the IPAddressID and IPAddress that were updated.",
  :throws=>["NOTFOUND", "VALIDATION"],
  :params=>
   {:hostname=>
     {:desc=>"The hostname to set the reverse DNS to",
      :type=>:string,
      :required=>true},
    :ipaddressid=>
     {:desc=>"The IPAddressID of the address to update",
      :type=>:numeric,
      :required=>true}}},
:swap=>
 {:type=>:call,
  :desc=>
   "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.",
  :throws=>["NOTFOUND", "VALIDATION"],
  :params=>
   {:ipaddressid=>
     {:desc=>"The IPAddressID of an IP Address to transfer or swap",
      :type=>:numeric,
      :required=>true},
    :tolinodeid=>
     {:desc=>
       "The LinodeID of the Linode where IPAddressID will be transfered",
      :type=>:numeric,
      :required=>false},
    :withipaddressid=>
     {:desc=>"The IP Address ID to swap",
      :type=>:numeric,
      :required=>false}}}}},
       :job=>
        {:type=>:group,
         :subs=>
          {:list=>
 {:type=>:call,
  :desc=>"",
  :throws=>[],
  :params=>
   {:jobid=>
     {:desc=>"Limits the list to the specified JobID",
      :type=>:numeric,
      :required=>false},
    :linodeid=>{:desc=>"", :type=>:numeric, :required=>true},
    :pendingonly=>
     {:desc=>"", :type=>:boolean, :required=>false}}}}},
       :list=>
        {:type=>:call,
         :desc=>
          "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.",
         :throws=>[],
         :params=>
          {:linodeid=>
 {:desc=>"Limits the list to the specified LinodeID",
  :type=>:numeric,
  :required=>false}}},
       :mutate=>
        {:type=>:call,
         :desc=>"Upgrades a Linode to its next generation.",
         :throws=>["NOTFOUND", "VALIDATION"],
         :params=>{:linodeid=>{:desc=>"", :type=>:numeric, :required=>true}}},
       :reboot=>
        {:type=>:call,
         :desc=>"Issues a shutdown, and then boot job for a given LinodeID.",
         :throws=>["NOTFOUND"],
         :params=>
          {:configid=>{:desc=>"", :type=>:numeric, :required=>false},
:linodeid=>{:desc=>"", :type=>:numeric, :required=>true}}},
       :resize=>
        {:type=>:call,
         :desc=>
          "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.",
         :throws=>["NOTFOUND", "CCFAILED", "VALIDATION"],
         :params=>
          {:linodeid=>{:desc=>"", :type=>:numeric, :required=>true},
:planid=>
 {:desc=>"The desired PlanID available from avail.LinodePlans()",
  :type=>:numeric,
  :required=>true}}},
       :shutdown=>
        {:type=>:call,
         :desc=>"Issues a shutdown job for a given LinodeID.",
         :throws=>["NOTFOUND"],
         :params=>{:linodeid=>{:desc=>"", :type=>:numeric, :required=>true}}},
       :update=>
        {:type=>:call,
         :desc=>"Updates a Linode's properties.",
         :throws=>["NOTFOUND", "VALIDATION"],
         :params=>
          {:alert_bwin_enabled=>
 {:desc=>"Enable the incoming bandwidth email alert",
  :type=>:boolean,
  :required=>false},
:alert_bwin_threshold=>
 {:desc=>"Mb/sec", :type=>:numeric, :required=>false},
:alert_bwout_enabled=>
 {:desc=>"Enable the outgoing bandwidth email alert",
  :type=>:boolean,
  :required=>false},
:alert_bwout_threshold=>
 {:desc=>"Mb/sec", :type=>:numeric, :required=>false},
:alert_bwquota_enabled=>
 {:desc=>"Enable the bw quote email alert",
  :type=>:boolean,
  :required=>false},
:alert_bwquota_threshold=>
 {:desc=>"Percentage of monthly bw quota",
  :type=>:numeric,
  :required=>false},
:alert_cpu_enabled=>
 {:desc=>"Enable the cpu usage email alert",
  :type=>:boolean,
  :required=>false},
:alert_cpu_threshold=>
 {:desc=>"CPU Alert threshold, percentage 0-800",
  :type=>:numeric,
  :required=>false},
:alert_diskio_enabled=>
 {:desc=>"Enable the disk IO email alert",
  :type=>:boolean,
  :required=>false},
:alert_diskio_threshold=>
 {:desc=>"IO ops/sec", :type=>:numeric, :required=>false},
:label=>
 {:desc=>"This Linode's label", :type=>:string, :required=>false},
:linodeid=>{:desc=>"", :type=>:numeric, :required=>true},
:backupweeklyday=>{:desc=>"", :type=>:numeric, :required=>false},
:backupwindow=>{:desc=>"", :type=>:numeric, :required=>false},
:lpm_displaygroup=>
 {:desc=>
   "Display group in the Linode list inside the Linode Manager",
  :type=>:string,
  :required=>false},
:ms_ssh_disabled=>{:desc=>"", :type=>:boolean, :required=>false},
:ms_ssh_ip=>{:desc=>"", :type=>:string, :required=>false},
:ms_ssh_port=>{:desc=>"", :type=>:numeric, :required=>false},
:ms_ssh_user=>{:desc=>"", :type=>:string, :required=>false},
:watchdog=>
 {:desc=>"Enable the Lassie shutdown watchdog",
  :type=>:boolean,
  :required=>false}}},
       :webconsoletoken=>
        {:type=>:call,
         :desc=>
          "Generates a console token starting a web console LISH session for the requesting IP",
         :throws=>["NOTFOUND", "VALIDATION"],
         :params=>
          {:linodeid=>{:desc=>"", :type=>:numeric, :required=>true}}}}},
   :nodebalancer=>
    {:type=>:group,
     :subs=>
      {:config=>
        {:type=>:group,
         :subs=>
          {:create=>
 {:type=>:call,
  :desc=>"",
  :throws=>["NOTFOUND", "VALIDATION"],
  :params=>
   {:algorithm=>
     {:desc=>
       "Balancing algorithm.  One of 'roundrobin', 'leastconn', 'source'",
      :type=>:string,
      :required=>false},
    :nodebalancerid=>
     {:desc=>"The parent NodeBalancer's ID",
      :type=>:numeric,
      :required=>true},
    :port=>
     {:desc=>"Port to bind to on the public interfaces. 1-65534",
      :type=>:numeric,
      :required=>false},
    :protocol=>
     {:desc=>"Either 'tcp', 'http', or 'https'",
      :type=>:string,
      :required=>false},
    :stickiness=>
     {:desc=>
       "Session persistence.  One of 'none', 'table', 'http_cookie'",
      :type=>:string,
      :required=>false},
    :check=>
     {:desc=>
       "Perform active health checks on the backend nodes.  One of 'connection', 'http', 'http_body'",
      :type=>:string,
      :required=>false},
    :check_attempts=>
     {:desc=>
       "Number of failed probes before taking a node out of rotation. 1-30",
      :type=>:string,
      :required=>false},
    :check_body=>
     {:desc=>
       "When check=http_body, a regex against the expected result body",
      :type=>:string,
      :required=>false},
    :check_interval=>
     {:desc=>"Seconds between health check probes.  2-3600",
      :type=>:numeric,
      :required=>false},
    :check_path=>
     {:desc=>"When check=http, the path to request",
      :type=>:string,
      :required=>false},
    :check_timeout=>
     {:desc=>
       "Seconds to wait before considering the probe a failure. 1-30.  Must be less than check_interval.",
      :type=>:string,
      :required=>false},
    :ssl_cert=>
     {:desc=>
       "SSL certificate served by the NodeBalancer when the protocol is 'https'",
      :type=>:string,
      :required=>false},
    :ssl_key=>
     {:desc=>
       "Unpassphrased private key for the SSL certificate when protocol is 'https'",
      :type=>:string,
      :required=>false}}},
:delete=>
 {:type=>:call,
  :desc=>"Deletes a NodeBalancer's Config",
  :throws=>["NOTFOUND"],
  :params=>
   {:configid=>
     {:desc=>"The ConfigID to delete",
      :type=>:numeric,
      :required=>true},
    :nodebalancerid=>
     {:desc=>"", :type=>:numeric, :required=>true}}},
:list=>
 {:type=>:call,
  :desc=>
   "Returns a list of NodeBalancers this user has access or delete to, including their properties",
  :throws=>[],
  :params=>
   {:configid=>
     {:desc=>"Limits the list to the specified ConfigID",
      :type=>:numeric,
      :required=>false},
    :nodebalancerid=>
     {:desc=>"", :type=>:numeric, :required=>true}}},
:update=>
 {:type=>:call,
  :desc=>"Updates a Config's properties",
  :throws=>["NOTFOUND", "VALIDATION"],
  :params=>
   {:algorithm=>
     {:desc=>
       "Balancing algorithm.  One of 'roundrobin', 'leastconn', 'source'",
      :type=>:string,
      :required=>false},
    :configid=>{:desc=>"", :type=>:numeric, :required=>true},
    :port=>
     {:desc=>"Port to bind to on the public interfaces. 1-65534",
      :type=>:numeric,
      :required=>false},
    :protocol=>
     {:desc=>"Either 'tcp', 'http', or 'https'",
      :type=>:string,
      :required=>false},
    :stickiness=>
     {:desc=>
       "Session persistence.  One of 'none', 'table', 'http_cookie'",
      :type=>:string,
      :required=>false},
    :check=>
     {:desc=>
       "Perform active health checks on the backend nodes.  One of 'connection', 'http', 'http_body'",
      :type=>:string,
      :required=>false},
    :check_attempts=>
     {:desc=>
       "Number of failed probes before taking a node out of rotation. 1-30",
      :type=>:string,
      :required=>false},
    :check_body=>
     {:desc=>
       "When check=http_body, a regex against the expected result body",
      :type=>:string,
      :required=>false},
    :check_interval=>
     {:desc=>"Seconds between health check probes.  2-3600",
      :type=>:numeric,
      :required=>false},
    :check_path=>
     {:desc=>"When check=http, the path to request",
      :type=>:string,
      :required=>false},
    :check_timeout=>
     {:desc=>
       "Seconds to wait before considering the probe a failure. 1-30.  Must be less than check_interval.",
      :type=>:string,
      :required=>false},
    :ssl_cert=>
     {:desc=>
       "SSL certificate served by the NodeBalancer when the protocol is 'https'",
      :type=>:string,
      :required=>false},
    :ssl_key=>
     {:desc=>
       "Unpassphrased private key for the SSL certificate when protocol is 'https'",
      :type=>:string,
      :required=>false}}}}},
       :create=>
        {:type=>:call,
         :desc=>"",
         :throws=>["NOACCESS", "CCFAILED", "VALIDATION"],
         :params=>
          {:clientconnthrottle=>
 {:desc=>
   "To help mitigate abuse, throttle connections per second, per client IP. 0 to disable. Max of 20.",
  :type=>:numeric,
  :required=>false},
:datacenterid=>
 {:desc=>
   "The DatacenterID from avail.datacenters() where you wish to place this new NodeBalancer",
  :type=>:numeric,
  :required=>true},
:label=>
 {:desc=>"This NodeBalancer's label",
  :type=>:string,
  :required=>false}}},
       :delete=>
        {:type=>:call,
         :desc=>
          "Immediately removes a NodeBalancer from your account and issues a pro-rated credit back to your account, if applicable.",
         :throws=>["NOTFOUND"],
         :params=>
          {:nodebalancerid=>
 {:desc=>"The NodeBalancerID to delete",
  :type=>:numeric,
  :required=>true}}},
       :list=>
        {:type=>:call,
         :desc=>
          "Returns a list of NodeBalancers this user has access or delete to, including their properties",
         :throws=>[],
         :params=>
          {:nodebalancerid=>
 {:desc=>"Limits the list to the specified NodeBalancerID",
  :type=>:numeric,
  :required=>false}}},
       :node=>
        {:type=>:group,
         :subs=>
          {:create=>
 {:type=>:call,
  :desc=>"",
  :throws=>["NOTFOUND", "VALIDATION"],
  :params=>
   {:address=>
     {:desc=>
       "The address:port combination used to communicate with this Node",
      :type=>:string,
      :required=>true},
    :configid=>
     {:desc=>"The parent ConfigID to attach this Node to",
      :type=>:numeric,
      :required=>true},
    :label=>
     {:desc=>"This backend Node's label",
      :type=>:string,
      :required=>true},
    :mode=>
     {:desc=>
       "The connections mode for this node.  One of 'accept', 'reject', or 'drain'",
      :type=>:string,
      :required=>false},
    :weight=>
     {:desc=>
       "Load balancing weight, 1-255. Higher means more connections.",
      :type=>:numeric,
      :required=>false}}},
:delete=>
 {:type=>:call,
  :desc=>"Deletes a Node from a NodeBalancer Config",
  :throws=>["NOTFOUND"],
  :params=>
   {:nodeid=>
     {:desc=>"The NodeID to delete",
      :type=>:numeric,
      :required=>true}}},
:list=>
 {:type=>:call,
  :desc=>
   "Returns a list of Nodes associated with a NodeBalancer Config",
  :throws=>[],
  :params=>
   {:configid=>{:desc=>"", :type=>:numeric, :required=>true},
    :nodeid=>
     {:desc=>"Limits the list to the specified NodeID",
      :type=>:numeric,
      :required=>false}}},
:update=>
 {:type=>:call,
  :desc=>"Updates a Node's properties",
  :throws=>["NOTFOUND", "VALIDATION"],
  :params=>
   {:address=>
     {:desc=>
       "The address:port combination used to communicate with this Node",
      :type=>:string,
      :required=>false},
    :label=>
     {:desc=>"This backend Node's label",
      :type=>:string,
      :required=>false},
    :mode=>
     {:desc=>
       "The connections mode for this node.  One of 'accept', 'reject', or 'drain'",
      :type=>:string,
      :required=>false},
    :nodeid=>{:desc=>"", :type=>:numeric, :required=>true},
    :weight=>
     {:desc=>
       "Load balancing weight, 1-255. Higher means more connections.",
      :type=>:numeric,
      :required=>false}}}}},
       :update=>
        {:type=>:call,
         :desc=>"Updates a NodeBalancer's properties",
         :throws=>["NOTFOUND", "VALIDATION"],
         :params=>
          {:clientconnthrottle=>
 {:desc=>
   "To help mitigate abuse, throttle connections per second, per client IP. 0 to disable. Max of 20.",
  :type=>:numeric,
  :required=>false},
:label=>
 {:desc=>"This NodeBalancer's label",
  :type=>:string,
  :required=>false},
:nodebalancerid=>{:desc=>"", :type=>:numeric, :required=>true}}}}},
   :stackscript=>
    {:type=>:group,
     :subs=>
      {:create=>
        {:type=>:call,
         :desc=>"Create a StackScript.",
         :throws=>["NOACCESS", "VALIDATION"],
         :params=>
          {:description=>{:desc=>"", :type=>:string, :required=>false},
:distributionidlist=>
 {:desc=>
   "Comma delimited list of DistributionIDs that this script works on ",
  :type=>:string,
  :required=>true},
:label=>
 {:desc=>"The Label for this StackScript",
  :type=>:string,
  :required=>true},
:ispublic=>
 {:desc=>
   "Whether this StackScript is published in the Library, for everyone to use",
  :type=>:boolean,
  :required=>false},
:rev_note=>{:desc=>"", :type=>:string, :required=>false},
:script=>
 {:desc=>"The actual script", :type=>:string, :required=>true}}},
       :delete=>
        {:type=>:call,
         :desc=>"",
         :throws=>["NOTFOUND"],
         :params=>
          {:stackscriptid=>{:desc=>"", :type=>:numeric, :required=>true}}},
       :list=>
        {:type=>:call,
         :desc=>"Lists StackScripts you have access to.",
         :throws=>[],
         :params=>
          {:stackscriptid=>
 {:desc=>"Limits the list to the specified StackScriptID",
  :type=>:numeric,
  :required=>false}}},
       :update=>
        {:type=>:call,
         :desc=>"Update a StackScript.",
         :throws=>["NOTFOUND", "VALIDATION"],
         :params=>
          {:description=>{:desc=>"", :type=>:string, :required=>false},
:distributionidlist=>
 {:desc=>
   "Comma delimited list of DistributionIDs that this script works on ",
  :type=>:string,
  :required=>false},
:label=>
 {:desc=>"The Label for this StackScript",
  :type=>:string,
  :required=>false},
:stackscriptid=>{:desc=>"", :type=>:numeric, :required=>true},
:ispublic=>
 {:desc=>
   "Whether this StackScript is published in the Library, for everyone to use",
  :type=>:boolean,
  :required=>false},
:rev_note=>{:desc=>"", :type=>:string, :required=>false},
:script=>
 {:desc=>"The actual script", :type=>:string, :required=>false}}}}},
   :test=>
    {:type=>:group,
     :subs=>
      {:echo=>
        {:type=>:call,
         :desc=>"Echos back parameters that were passed in.",
         :throws=>[],
         :params=>{}}}},
   :user=>
    {:type=>:group,
     :subs=>
      {:getapikey=>
        {:type=>:call,
         :desc=>
          "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.",
         :throws=>["AUTHFAIL", " NEEDTOKEN", " PASSWORDEXPIRED", " KEYLIMIT"],
         :params=>
          {:expires=>
 {:desc=>
   "Number of hours the key will remain valid, between 0 and 8760. 0 means no expiration. Defaults to 168.",
  :type=>:numeric,
  :required=>false},
:label=>
 {:desc=>"An optional label for this key.",
  :type=>:string,
  :required=>false},
:password=>{:desc=>"", :type=>:string, :required=>true},
:token=>
 {:desc=>"Required when two-factor authentication is enabled.",
  :type=>:string,
  :required=>false},
:username=>{:desc=>"", :type=>:string, :required=>true}}}}}}}

Class Method Summary

• .new(*args) ⇒ Object

  Insert a helper .new() method for creating a new API object.

Class Method Details

.new(*args) ⇒ Object

Insert a helper .new() method for creating a new API object

# File 'lib/linodeapi.rb', line 13

def new(*args)
  self::API.new(*args)
end