XML API is the main integration API used to perform certain actions in Plesk Expand.
You can learn how the basic operation principles of Plesk Expand XML API and learn to compose queries in subsection Composing XML Commands, further in this section. A reader of this guide must be familiar with XML (Extensible Markup Language) and XML Schema. More information on XML and Schema specification can be found at the World Wide Web Consortium site.
In order to perform a certain action via XML API, the following typical steps are required:
1. Compose an XML query containing all the necessary input parameters according to the guidelines set in subsection Composing XML Commands. These XML packets are rigidly structured and this structure is described in XML Schema files (
*.xsd). You can find the Schema specification in the project documentation. The Schema usage rules are outlined in Chapter 4. Reference Materials in section Obtaining Operator Usage Info.
2. Save this query in a separate
.xml file. The filename format is arbitrary.
2. Direct the file to the standard input (
stdin) of an Operator responsible for this action type. For example, if you wish to create a domain, use the
exp_plesk_domain operator. For a full list of available Operators, refer to Plesk Expand Operators.
3. The results are presented in the form of the XML packet which can be obtained on the standard output of the Operator.
See a sample statement for operation "Create a domain" further in this section.