API: Controlling server status

servers.list

Description

Fetch servers list for certain user.

Command specific parameters

None.

Command specific response

Array of servers.

Name Description
servers/server/serverId Server ID
servers/server/name Server name
servers/server/status Server status
Sample response
...
<servers>
  <server>
    <serverId>xxx</serverId>
    <name>yyy</name>
    <status>online</status>
  </server>
  ...
</servers>
...

server.info

Description

Gets information about specific server.

Command specific parameters
Name Description
serverId Server ID
Command specific response

Array of servers.

Name Description
server/serverId Server ID
server/os Operating system
net/speed Interface speed
net/address Server IPv4 address information block
net/address[addressId] IPv4 address ID
net/address[role=main\|additional] IPv4 address type
net/address/addr IPv4 address
net/address/gw Gateway address
net/address/mask IP address mask
hw/component Component description
Sample response
<server>
  <serverId>xxx</serverId>
  <os osID="XX">YY</os>
  <net>
    <speed>AA</speed>
    <address addressId="XX" role="additional">
      <addr>XXX</addr>
    </address>
    <address addressId="XX" role="main">
      <addr>XX</addr>
      <gw>XX</gw>
      <mask>XX</mask>
    </address>
  </net>
  <hw>
    <component>AA</component>
    <component>BB</component>
  </hw>
  <storage>
    <storage id="XX">
      <user>XX</user>
      <pass>XX</pass>
      <used>XX</used>
    </storage>
  </storage>
  <traffic>
    <cycle from="AA" to="BB">XX</cycle>
  </traffic>
</server>

server.stop

Description

Stops dedicated server.

Command specific parameters
Name Description
serverId Server ID
Command specific response

None.

server.start

Description

Starts dedicated server.

Command specific parameters
Name Description
serverId Server ID
Command specific response

None.

server.restart

Description

Reboots dedicated server.

Command specific parameters
Name Description
serverId Server ID
Command specific response

None.

server.change-name

Description

Changes dedicated server name.

Command specific parameters
Name Description
serverId Server ID
ownName New server name
Command specific response

None.

server.crash

This method is obsolete. Please use tt.add method instead.

Description

Reports problem with dedicated server to customer support.

Command specific parameters
Name Description
serverId Server ID
message Message content
Command specific response

None.

server.status.refresh

Description

Forces to refresh server status.

Usage of this method is limited: no more than 0.2 rq/min per server.

Command specific parameters
Name Description
serverId Server ID
Command specific response
Name Description
server/serverId Server ID
server/status Server status
Sample response
...
<server>
  <serverId>xxx</serverId>
  <status>online</status>
</server>
...