(8 intermediate revisions by one user not shown) | |||
Line 1: | Line 1: | ||
− | The list command will return a list of all the servers that are associated with your account, those being dedicated, dynamic and | + | The [[Server|server]] list command will return a list of all the servers that are associated with your account, those being [[servers#Dedicated Server|dedicated]], [[servers#Dynamic Server|dynamic]] and [[glossary#Virtual Machine|virtual machines]] servers. |
==Path== | ==Path== | ||
*/server/list | */server/list | ||
==Method== | ==Method== | ||
− | *GET | + | *[[glossary#GET|GET]] |
==Availability== | ==Availability== | ||
− | *[[Dedicated Server]] | + | *[[servers#Dedicated Server|Dedicated Server]] |
− | *[[Dynamic Server]] | + | *[[servers#Dynamic Server|Dynamic Server]] |
− | *[[Private Cloud]] | + | *[[servers#Private Cloud|Private Cloud]] |
− | *[[Public Cloud]] | + | *[[servers#Public Cloud|Public Cloud]] |
==Required Data Parameters== | ==Required Data Parameters== | ||
− | * | + | *None |
==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 [[glossary#Virtual Machine|virtual machines]] that have been created on them by adding the {$serverid} to the path, /server/list/{$serverid}. |
==Returned Data== | ==Returned Data== |
The server list command will return a list of all the servers that are associated with your account, those being dedicated, dynamic and virtual machines servers.
Contents |
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}.
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. ) ) )