Server List

From INAP Dropzone API
(Difference between revisions)
Jump to: navigation, search
Line 17: Line 17:
 
==Optional Data Parameters==
 
==Optional Data Parameters==
 
*{$serverid}
 
*{$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}.
+
For each [[servers#Dynamic Server|dynamic server]] you are able to list all of the [[servers#Virtual Machine|virtual machines]] that have been created on them by adding the {$serverid} to the path, /server/list/{$serverid}.
  
 
==Returned Data==
 
==Returned Data==

Revision as of 23:05, 24 March 2012

The server 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

Availability

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