Server List

From INAP Dropzone API
(Difference between revisions)
Jump to: navigation, search
(Created page with "The list command will return a list of all the servers that are associated with your account, those being dedicated, dynamic and cloud servers. ==Path== */server/list ==Metho...")
 
Line 7: Line 7:
  
 
==Required Data Parameters==
 
==Required Data Parameters==
*None
+
*none
  
==Returned Data Parameters==
+
==Optional Data Parameters==
 +
*{$serverid}
 +
For each [[Dynamic Server|dynamic server]] you are able to list all of the [[Virtual Machine|virtual machines]] that have been created on them by adding the {$serverid} to the path, /server/list/{$serverid}.
 +
 
 +
==Returned Data==
 
<pre>
 
<pre>
 
stdClass Object(
 
stdClass Object(

Revision as of 19:12, 9 March 2012

The list command will return a list of all the servers that are associated with your account, those being dedicated, dynamic and cloud servers.

Contents

Path

  • /server/list

Method

  • GET

Required Data Parameters

  • none

Optional Data Parameters

  • {$serverid}

For each dynamic server you are able to list all of the virtual machines that have been created on them by adding the {$serverid} to the path, /server/list/{$serverid}.

Returned Data

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.
    )
  )
)
Personal tools