XML Schemas for XML API Operators
This chapter lists XML API 1.6.7.0 XML schemas that define the format of messages sent to and received from Plesk API operators.
To view a schema, click a link next to the required operator.
An entry point to the input XML schemas is agent_input.xsd. This file references all lower-level input schemas available. An entry point to the output XML schemas is agent_output.xsd. This file references all lower-level output schemas available. Interactive schema navigators are available at http://plesk.github.io/api-schemas/.
The current protocol version supports operations on the following Plesk objects:
|
SUPPORTED OPERATION |
OPERATOR |
SCHEMAS |
AVAILABLE TO |
|
APS |
aps |
Administrator |
|
|
Backup operations
|
backup-manager |
Administrator, Reseller, Customer |
|
|
Certificate operations |
certificate |
Administrator |
|
|
Customer operations |
customer |
Administrator, Reseller |
|
|
Database server operations |
db_server |
Administrator |
|
|
Descriptor structure |
- |
Administrator, Reseller, Customer |
|
|
DNS operations |
dns |
Administrator |
|
|
Event Logging |
event_log |
Administrator |
|
|
Localization operations |
locale |
Administrator |
|
|
Log rotation operations |
log-rotation |
Administrator |
|
|
Additional FTP account operations |
ftp-user |
Administrator, Reseller, Customer |
|
|
IP operations |
ip |
Administrator |
|
|
IP address banning (Fail2Ban) |
ip-ban |
Administrator |
|
|
Mail operations |
|
Administrator |
|
|
Mailing list operations |
maillist |
Administrator, Customer |
|
|
Migration operations |
migration |
migration_input.xsd, migration_output.xsd, plesk_migration.xsd |
Administrator |
|
Protected directory operations |
protected_dir |
Administrator, Customer |
|
|
Reseller operations
|
reseller |
Administrator |
|
|
Reseller plan operations |
reseller-plan |
Administrator |
|
|
Reseller plan operations |
role |
Administrator |
|
|
Secret key operations |
secret_key |
secret_key_input.xsd, secret_key_output.xsd, plesk_secretkeys.xsd |
Administrator |
|
Server operations |
server |
Administrator |
|
|
Session management operations |
session |
Administrator |
|
|
Service plan operations |
service-plan |
Administrator, Reseller |
|
|
Service plan addon operations |
service-plan-addon |
Administrator, Reseller |
|
|
Site operations |
site |
Administrator, Reseller, Customer |
|
|
SiteApp operations |
siteapp |
Administrator |
|
|
Domain alias operations |
site-alias |
domainalias_input.xsd, domainalias_output.xsd, plesk_domainalias.xsd |
Administrator, Reseller, Customer |
|
Spam filtering |
spamfilter |
Administrator |
|
|
Subdomain operations |
subdomain |
Administrator, Reseller, Customer |
|
|
User interface operations |
ui |
Administrator |
|
|
Updater operations |
updater |
Administrator |
|
|
Upload |
upload |
Administrator |
|
|
Operations with auxiliary webspace users |
user |
Administrator, Reseller, Customer |
|
|
Virtual directory operations |
virtdir |
Administrator |
|
|
Domain operations |
webspace |
Administrator, Reseller, Customer |
|
|
Web user operations |
webuser |
Administrator, Customer |
Simple and commonly used types are provided in schemas common.xsd and plesk_common.xsd.