Server

From INAP Dropzone API
(Difference between revisions)
Jump to: navigation, search
(View)
(Dedicated Server & Cloud Commands)
Line 1: Line 1:
 
==Dedicated Server & Cloud Commands==
 
==Dedicated Server & Cloud Commands==
===List===
+
*[[Server List]]: Lists all active servers in your Leap account.
The list command will return a list of all the servers that are associated with your account, those being dedicated, dynamic and cloud servers.
+
*[[Server View]]: Lists details about a specific server
 
+
'''Path'''
+
*/server/list
+
'''Method'''
+
*GET
+
'''Required Data Parameters'''
+
*None
+
'''Returned Data Parameters'''
+
<pre>
+
stdClass Object(
+
  [success] => TRUE/FALSE
+
  [data] => Array(
+
    [0] => stdClass Object(
+
      [status] => Server status (online,offline,provisioning).
+
      [serverid] => Server ID number.
+
      [os] => Currently installed operating system.
+
      [hostname] => Server host name, as in "leap.singlehop.com".
+
      [ram] => Amount of RAM and type installed.
+
      [type] => Type of server (server,vmnode,vm).
+
      [cputype] => Type of CPU that is currently installed.
+
      [cpuspeed] => Speed of the installed CPU in GHz.
+
    )
+
  )
+
)
+
</pre>
+
 
+
===View===
+
The view command will return basic server information along with it's current hardware configuration.
+
 
+
'''Path'''
+
*/server/view
+
'''Method'''
+
*GET
+
'''Required Data Parameters'''
+
*None
+
'''Returned Data Parameters'''
+
<pre>
+
stdClass Object(
+
  [success] => TRUE/FALSE
+
  [data] => Array(
+
    [serverid] => Server ID number.
+
    [type] => Type of server (server,vmnode,vm).
+
    [status] => Server status (online,offline,provisioning).
+
    [hostname] => Server host name, as in "leap.singlehop.com".
+
    [password] => Root username password.
+
    [location] => Server rack and slot number.
+
    [datacenter] => Server datacenter (dupont,cimco)
+
    [primaryip] => Primary public IP Address.
+
    [privateip] => Private IP Address.
+
    [os] => Currently installed operating system.
+
    [osdetails] => stdClass Object(
+
      [id] => Currently installed operating system id.
+
      [name] => Currently installed operating system name.
+
      [arch] => Currently installed operating system architecture.
+
      [controlpanel] => Currently installed control panel (cpanel,plesk).
+
    )
+
    [firewall] => TRUE/FALSE
+
    [privatenetwork] => TRUE/FALSE
+
    [network] => Current speed of the servers public uplink port(100Mbit,1Gbit).
+
    [hardware] => stdClass Object(
+
      [ramslots] => Number of RAM slots on the motherboard.
+
      [ram] => Amount of RAM in GB.
+
      [diskslots] => Number of hard drives the server can hold
+
      [disks] => Array() Size of each hard drive installed (GB,TB).
+
      [cpuslots] => Number of CPU sockets on the motherboard.
+
      [cpucount] => Number of installed CPUs on the motherboard.
+
      [cputype] => Type of CPU that is currently installed.
+
      [cpuspeed] => Speed of the installed CPU in GHz.
+
      [disktotal] => Total hard drive space installed in GB.
+
    )
+
    [bandwidth] => Maximum allowed outbound bandwidth in GB.
+
    [backup] => stdClass Object(
+
      [type] => Backup server type (r1soft).
+
      [user] => Backup server username.
+
      [host] => Backup server hostname.
+
      [pass] => Backup server password.
+
    )
+
  )
+
)
+
</pre>
+
  
 
==Dedicated Server Only Commands==
 
==Dedicated Server Only Commands==

Revision as of 18:53, 9 March 2012

Contents

Dedicated Server & Cloud Commands

  • Server List: Lists all active servers in your Leap account.
  • Server View: Lists details about a specific server

Dedicated Server Only Commands

Dynamic Server Only Commands

/server/list/SERVERID

Private/Public Cloud Only Commands

Personal tools