vserver_list ()
This function returns list of all VPSs under your account.
| HTTP Method: | GET | |
|---|---|---|
| Parameters: | sid | session id |
| Returns: | HTTP code | 200 (OK) |
| vserver_id | unique id of VPS | |
| server_status | status of the VPS (Running, Paused, Shut off, Waiting for payment, Blocked) | |
| ipv4 | primary IPv4 addres of the VPS | |
| ipv6 | primary IPv6 addres of the VPS | |
| vserver_name | internal VPS name | |
| custom_name | custom name of VPS | |
| node_name | name of underlying node server | |
| order_id | unique ID of order of this VPS (if available) | |
| action_lock | lock for power on/off and restart from client section | |
| expiration_date | current expiration date of the VPS |
Return errors
| Error code | HTTP response code | Description |
|---|---|---|
| 1 | 400 (Bad request) | Function was not performed, because all required parameters were not entered. Reply portion reply is empty. |
| 3 | 403 (Forbidden) | Function call failed, invalid sid parameter. Create new sid using /api/login function. Reply portion reply is empty. |
CURL
curl "https://admin.systems90.cz/api/vserver_list?sid=%sid%"
PHP Library
$api->vserver_detail(array());
Example of data output
<?xml version="1.0" encoding="UTF-8"?>
<reply>
<status>
<code>0</code>
<text>OK</text>
</status>
<vservers>
<vserver>
<vserver_id>399</vserver_id>
<server_status>Running</server_status>
<ipv4>130.193.12.187</ipv4>
<ipv6>2a03:b780:0001:0000:216:3eff:fe00:7bb</ipv6>
<name>virtual_399</name>
<custom_name>Linux server</custom_name>
<node>hc-vh22</node>
<order_id>4582</order_id>
<action_lock>0</action_lock>
<expiration/>
</vserver>
<vserver>
<vserver_id>8881</vserver_id>
<server_status>Running</server_status>
<ipv4>130.193.12.246</ipv4>
<ipv6>2a03:b780:0001:0000:216:3eff:fe00:7f6</ipv6>
<name>virtual_8881</name>
<custom_name>Win2012</custom_name>
<node>hc-vh33</node>
<order_id>5877</order_id>
<action_lock>0</action_lock>
<expiration/>
</vserver>
<vserver>
<vserver_id>55297</vserver_id>
<server_status>Parking</server_status>
<ipv4>37.46.83.248</ipv4>
<ipv6>2a03:b780:0001:0004:216:3eff:fe00:df8</ipv6>
<name>virtual_55297</name>
<custom_name>Roundcube server</custom_name>
<node/>
<order_id>33834</order_id>
<action_lock>0</action_lock>
<expiration/>
</vserver>
<vserver>
<vserver_id>56070</vserver_id>
<server_status>Running</server_status>
<ipv4>130.193.9.41</ipv4>
<ipv6>2a03:b780:0001:0001:216:3eff:fe00:529</ipv6>
<name>virtual_56070</name>
<custom_name>Test</custom_name>
<node>hc-vh114</node>
<order_id>34657</order_id>
<action_lock>0</action_lock>
<expiration/>
</vserver>
<vserver>
<vserver_id>56972</vserver_id>
<server_status>Running</server_status>
<ipv4>37.46.83.61</ipv4>
<ipv6>2a03:b780:0001:0004:216:3eff:fe00:d3d</ipv6>
<name>virtual_56972</name>
<custom_name>DB devel Alfa</custom_name>
<node>hc-vh114</node>
<order_id>35726</order_id>
<action_lock>0</action_lock>
<expiration/>
</vserver>
<vserver>
<vserver_id>57281</vserver_id>
<server_status>Running</server_status>
<ipv4>37.46.83.210</ipv4>
<ipv6>2a03:b780:0001:0004:216:3eff:fe00:dd2</ipv6>
<name>virtual_57281</name>
<custom_name>DB devel Beta</custom_name>
<node>hc-vh115</node>
<order_id>36044</order_id>
<action_lock>0</action_lock>
<expiration/>
</vserver>
<vserver>
<vserver_id>60168</vserver_id>
<server_status>Running</server_status>
<ipv4>37.46.83.212</ipv4>
<ipv6>2a03:b780:0001:0004:216:3eff:fe00:dd4</ipv6>
<name>virtual_60168</name>
<custom_name>Devel</custom_name>
<node>hc-vh114</node>
<order_id>39395</order_id>
<action_lock>0</action_lock>
<expiration/>
</vserver>
<vserver>
<vserver_id>60253</vserver_id>
<server_status>Parking</server_status>
<ipv4>37.46.83.145</ipv4>
<ipv6>2a03:b780:0001:0004:216:3eff:fe00:d91</ipv6>
<name>virtual_60253</name>
<custom_name>map tool 2N</custom_name>
<node/>
<order_id>39507</order_id>
<action_lock>0</action_lock>
<expiration/>
</vserver>
<vserver>
<vserver_id>60307</vserver_id>
<server_status>Running</server_status>
<ipv4>130.193.10.136</ipv4>
<ipv6>2a03:b780:0001:0000:216:3eff:fe00:288</ipv6>
<name>virtual_60307</name>
<custom_name>Preconfig LAMP c7</custom_name>
<node>hc-vh114</node>
<order_id>39578</order_id>
<action_lock>0</action_lock>
<expiration/>
</vserver>
<vserver>
<vserver_id>60457</vserver_id>
<server_status>Running</server_status>
<ipv4>130.193.12.124</ipv4>
<ipv6>2a03:b780:0001:0000:216:3eff:fe00:77c</ipv6>
<name>virtual_60457</name>
<custom_name>Preconfig Echange c7</custom_name>
<node>hc-vh116</node>
<order_id>39754</order_id>
<action_lock>0</action_lock>
<expiration/>
</vserver>
<vserver>
<vserver_id>63243</vserver_id>
<server_status>Running</server_status>
<ipv4>37.46.80.45</ipv4>
<ipv6>2a03:b780:0001:0004:216:3eff:fe00:a2d</ipv6>
<name>virtual_63243</name>
<custom_name>DB Devel ha3 - c7</custom_name>
<node>hc-vh115</node>
<order_id>49082</order_id>
<action_lock>0</action_lock>
<expiration/>
</vserver>
<vserver>
<vserver_id>63290</vserver_id>
<server_status>Running</server_status>
<ipv4>37.46.80.59</ipv4>
<ipv6>2a03:b780:0001:0004:216:3eff:fe00:a3b</ipv6>
<name>virtual_63290</name>
<custom_name>DB Devel ha1</custom_name>
<node>hc-vh110</node>
<order_id>49157</order_id>
<action_lock>0</action_lock>
<expiration/>
</vserver>
<vserver>
<vserver_id>63291</vserver_id>
<server_status>Running</server_status>
<ipv4>37.46.80.2</ipv4>
<ipv6>2a03:b780:0001:0004:216:3eff:fe00:a02</ipv6>
<name>virtual_63291</name>
<custom_name>DB Devel ha2</custom_name>
<node>hc-vh110</node>
<order_id>49158</order_id>
<action_lock>0</action_lock>
<expiration/>
</vserver>
<vserver>
<vserver_id>63662</vserver_id>
<server_status>Parking</server_status>
<ipv4>37.46.85.108</ipv4>
<ipv6>2a03:b780:0001:0004:216:3eff:fe00:106c</ipv6>
<name>virtual_63662</name>
<custom_name>InnoSetup / lazarus</custom_name>
<node/>
<order_id>49698</order_id>
<action_lock>0</action_lock>
<expiration/>
</vserver>
<vserver>
<vserver_id>64066</vserver_id>
<server_status>Running</server_status>
<ipv4>37.46.83.62</ipv4>
<ipv6>2a03:b780:0001:0004:216:3eff:fe00:d3e</ipv6>
<name>virtual_64066</name>
<custom_name>Debian</custom_name>
<node>hc-vh116</node>
<order_id>51531</order_id>
<action_lock>0</action_lock>
<expiration/>
</vserver>
<vserver>
<vserver_id>64245</vserver_id>
<server_status>Running</server_status>
<ipv4>37.46.85.239</ipv4>
<ipv6>2a03:b780:0001:0004:216:3eff:fe00:10ef</ipv6>
<name>virtual_64245</name>
<custom_name>Virt-install</custom_name>
<node>hc-vh116</node>
<order_id>51729</order_id>
<action_lock>0</action_lock>
<expiration/>
</vserver>
<vserver>
<vserver_id>64443</vserver_id>
<server_status>Shut off</server_status>
<ipv4>37.46.80.129</ipv4>
<ipv6>2a03:b780:0001:0004:216:3eff:fe00:a81</ipv6>
<name>virtual_64443</name>
<custom_name>Test autorunning</custom_name>
<node>hc-vh2</node>
<order_id>51954</order_id>
<action_lock>0</action_lock>
<expiration/>
</vserver>
<vserver>
<vserver_id>65359</vserver_id>
<server_status>Running</server_status>
<ipv4>130.193.15.66</ipv4>
<ipv6>2a03:b780:0001:0000:216:3eff:fe00:1142</ipv6>
<name>virtual_65359</name>
<custom_name>Kerio Operator Test</custom_name>
<node>hc-vh5</node>
<order_id>53533</order_id>
<action_lock>0</action_lock>
<expiration/>
</vserver>
</vservers>
</reply>