This chapter contains instructions about managing available Plesk objects programmatically via Plesk XML API protocol. Each section is devoted to a particular object or range of objects. For your convenience the sections are arranged in alphabetical order.

Each section, at first, lists all operations on the objects that are supported by XML API, then each operation is considered in detail with XML code samples. The detailed description touches upon the structure of the request and response packets.

In this chapter:

Before Using The Reference

XML Schemas for XML API Operators

Managing Add-on Plans

Managing APS Catalog and Applications

Managing Auxiliary Users

Managing Backups

Managing Additional Services of Service Plans

Managing Customer Accounts

Managing Database Servers

Managing Databases

Managing DNS

Managing External Webmail Services

Managing FTP Accounts

Managing Integration With Presence Builder

Managing IP Addresses

Managing IP Address Banning (Fail2Ban)

Managing Locales

Managing Log Rotation on Domain

Managing Mail

Managing Mailing Lists

Managing PHP Handlers

Managing Plesk Administrator Information

Managing Plesk Components

Managing Plesk License

Managing Plesk Server

Managing Plesk Services

Managing Plesk Updates

Managing Protected Directories

Managing Reseller Accounts

Managing Reseller Plans

Managing Roles of Auxiliary Users

Managing Secret Keys

Managing Service Plans

Managing Sessions

Managing Sites (Domains)

Managing Site Aliases

Managing Spam Filtering Service

Managing SSL Certificates

Managing SSO Service

Managing Subdomains

Managing Subscriptions (Webspaces)

Managing WordPress Installations

Managing User Interface (Custom Buttons)

Managing Virtual Directories

Managing Web Users

Migrating Subscriptions and Customer Accounts

Installing Plesk Extensions

Retrieving Action Log Data

Representation of Object Descriptor

Setting up Connection to Business Manager

Uploading Files to Server

Managing ICP Permits