Managing Plesk Administrator Information

In this chapter:

Administrator Personal Information

Changing Administrator Information

Retrieving Administrator Information

 

Administrator Personal Information

Personal information of Plesk server Administrator is held by the admin node presented by complex type adminType (plesk_server.xsd). Together with the personal info, the node specifies if the Plesk announcements should be sent to the Administrator's e-mail.

The node is structured as follows:

  • The admin_cname node is required. It holds the administrator's company name. Data type: string (0 to 60 characters long).
  • The admin_pname node is required. It holds the administrator's personal name. Data type: string (0 to 60 characters long).
  • The admin_phone node is required. It holds the administrator's phone number. Data type: string.
  • The admin_fax node is required. It holds the administrator's fax number. Data type: string.
  • The admin_email node is required. It holds the administrator's e-mail address. Data type: emailType (common.xsd).
  • The admin_address node is required. It holds the administrator's street address. Data type: string.
  • The admin_city node is required. It holds the name of the city where administrator lives. Data type: string.
  • The admin_state node is required. It holds the name of state (for US citizens) or province where administrator lives. Data type: string.
  • The admin_pcode node is required. It holds the administrator's zip/ postal code. Data type: zipcodeType (common.xsd).
  • The admin_country node is required. It holds the name of the country where administrator lives. Data type: string. Value restrictions: two-letters upper-case country nomination in accordance with ISO 3166.
  • The send_announce node is required. It specifies whether Plesk announcement messages are sent to the administrator's e-mail specified in the admin_email node . Data type: boolean.
  • The uid and the global-login nodes are deprecated.

 

 

Changing Administrator Information

XML request packet changing Administrator's personal information and settings looks as follows:

<packet>
<server>
<set>
   <admin>
      <admin_cname>JohnDoe BV.</admin_cname>
      <admin_pname>John Doe</admin_pname>
      <admin_phone>+49 89333333</admin_phone>
      <admin_fax>+49 893333303</admin_fax>
      <admin_email>john@doe.de</admin_email>
      <admin_address>Theatinerstrasse 96</admin_address>
      <admin_city>Muenchen</admin_city>
      <admin_state>Bavaria</admin_state>
      <admin_pcode>80333</admin_pcode>
      <admin_country>DE</admin_country>
      <send_announce>true</send_announce>
   </admin>
</set>
</server>
</packet>

 

 

Retrieving Administrator Information

A response XML packet retrieving Administrator's personal information and settings looks as follows:

<packet>
<server>
<get>
   <result>
      <status>ok</status>
      <admin>
         <admin_cname>JohnDoe BV.</admin_cname>
         <admin_pname>John Doe</admin_pname>
         <admin_phone>+49 89333333</admin_phone>
         <admin_fax>+49 893333303</admin_fax>
         <admin_email>john@doe.de</admin_email>
         <admin_address>Theatinerstrasse 96</admin_address>
         <admin_city>Muenchen</admin_city>
         <admin_state>Bavaria</admin_state>
         <admin_pcode>80333</admin_pcode>
         <admin_country>DE</admin_country>
         <send_announce>true</send_announce>
      </admin>
   </result>
</get>
</server>
</packet>

 

 

Leave your comments on this page

Leave your feedback or question on this documentation topic below. For technical assistance, contact your hosting service provider or submit a request to Plesk support. Suggest new features for Plesk here. Discuss general questions on the Plesk forum. All offtopic comments will be removed.