Getting Custom Buttons List

Each site has buttons available from the Control Panel. For example, Mail settings, File manager, etc. To get the list of all such buttons, send the cform_buttons_list request packet to the Panel.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 

Request Packet Structure

A request XML packet getting the list of webspace buttons includes the cform_buttons_list operation node:

<packet version="1.6.3.0">
<site>
   <cform_buttons_list>
   ...
   </cform_buttons_list>
</site>
</packet>

 

The cform_buttons_list node does not have a separate data type, it is nested within the complex type (site.xsd). The cform_buttons_list node has the following graphics representation:

getMessage

 

 

Response Packet Structure

The cform_buttons_list node of the response packet is structured as follows:

site-cform_buttons_list-reps.gif

 

Buttons are described by complex type buttonDataType (plesk_common.xsd) as follows:

site-cform-button.gif

 

 

Samples

This packet contains different filtering rules to remove sites:

<packet version="1.6.3.0">
<site>
   <cform_buttons_list>
     <filter>
       <id>19</id>
     </filter>
   </cform_buttons_list>
</site>
</packet>

 

This packet requests to remove all sites owned by a packet sender:

<packet version="1.6.3.0">
<site>
<del>
   <filter/>
</del>
</site>
</packet>