Plesk API RPC Protocol

To support interaction between Plesk and third-party software, Plesk provides XML-based API. This interface exposes a set of functions for managing Plesk logical objects. The Plesk API RPC protocol was designed as a means of calling to these API functions remotely. This is the XML-over-HTTP protocol that exchanges data in the form of specifically formatted packets.

Who can use Plesk API RPC protocol

At the moment, the use of Plesk API RPC protocol is allowed to Plesk Administrator, Plesk resellers and Plesk clients (the list of API RPC users tends to be enlarged). These users are provided with programmatic means of managing various Plesk objects they own.

• Plesk Administrator is allowed to perform all operations of whatever version of the API RPC protocol they use.
• Plesk clients/resellers have access to a limited number of operations within each particular version of API RPC. When using a Plesk client/reseller account, a strict requirement is that options 'CP access' and 'Ability to use remote XML interface' are enabled, of which Plesk Administrator should be requested in advance.

Note: There are no API RPC versions designed specifically for Plesk for Linux/Unix or Plesk for Windows. Both products share the same versions of Plesk API RPC protocol.

What versions of Plesk API RPC protocol are in use

Plesk API RPC protocol evolves in sync with Plesk constantly: When new features appear in Plesk, they are implemented in the protocol. Here are the versions of Plesk API RPC protocol recommended for use with the later versions of Plesk:

Protocol Backward Compatibility

Every version of Plesk supports all versions of Plesk API RPC existing by the moment of the product release. For instance, Plesk 7.6.1 supports version 1.4.1.1 of API RPC, but it will is compatible with versions 1.4.0.0 and earlier, too.