Request Packet Structure and Samples

A request XML packet retrieving information on server and Plesk configuration contains the get operation node:

<packet>
  <server>
    <get>
      ...
    </get>
  </server>
</packet>

The get node is presented by complex type getType (server_input.xsd) and structured as follows:

• The key node is optional. It retrieves Plesk license key. Data type: none (common.xsd).
• The gen_info node is optional. It retrieves general server information which is now presented by the server name. Data type: none (common.xsd).
• The components node is optional. It retrieves software components installed on the server and managed by Plesk. Data type: none (common.xsd).
• The stat node is optional. It retrieves Plesk and OS versions, and statistics on the server resources usage and Plesk logical objects. Data type: none (common.xsd).
• The admin node is optional. It retrieves Plesk Administrator's personal information and settings. Data type: none (common.xsd).
• The interfaces node is optional. It retrieves network interfaces supported by the server. Data type: none (common.xsd).
• The services_state node is optional. It retrieves current state of the server services, such as DNS service, FTP service, Mail service, Fail2Ban, and so on. Data type: none (common.xsd).
• The prefs node is optional. It retrieves such server preferences as settings of traffic usage statistics and apache restart interval. Data type: none (common.xsd).
• The shells node is optional. It retrieves shells installed on the server and available for choice when configuring a site's physical hosting. Data type: none (common.xsd).
• The session_setup node is optional. It retrieves session idle time, namely, the amount of time a session with Plesk should stay valid when no actions are performed. Data type: none (common.xsd).
• The updates node is optional. It retrieves the information about installed and available Plesk updates, missed security updates, and Plesk update policy. Data type: none (common.xsd).
• The admin-domain-list node is optional. It retrieves the information about all domains, addon domains, subdomains, and domain aliases created in the administrator's webspaces. Data type: none (common.xsd).

To retrieve specific server information, include the corresponding child nodes to your request. For example, to retrieve currently installed components and license key, send the following request packet:

<packet>
  <server>
    <get>
       <key/>
       <components/>
    </get>
  </server>
</packet>

To retrieve server general information, statistics and preferences, send the following request packet:

<packet>
  <server>
    <get>
       <gen_info/>
       <stat/>
       <prefs/>
    </get>
  </server>
</packet>

To retrieve the list of administrator's domains, send the following request packet:

<packet>
  <server>
    <get>
       <admin-domain-list/>
    </get>
  </server>
</packet>