Introduction

Technology

Key Administrator Partner API 1.0 is based on the XML-RPC protocol. XML-RPC is a Remote Procedure Call protocol that works over the Internet. An XML-RPC message is an HTTP-POST request. The body of the request is in XML. A procedure executes on the server and the value(s) it returns is also formatted in XML.

Procedure parameters can be numbers, strings, dates, and so on, and can also be complex records and list structures. Particular parameters and return values are command-specific. By default, all command parameters and structure fields are required.

Note: Partner API 3.0, a newer version of the Partner API based on another technology, is available.

Access Points

Partner API endpoint is available at:

  • For Plesk licenses: https://ka.plesk.com:7050
  • For Virtuozzo licenses: https://ka.virtuozzo.com:7050

Note: The following article explains why it is necessary to use different Partner API endpoints for Plesk and Virtuozzo products: https://support.plesk.com/hc/en-us/articles/115000876289.

For testing purposes use the following URL (available only for Plesk licenses now):

https://ka.demo.plesk.com:7050

Please note that it is mandatory to use secured connections (HTTP over SSL).

Note: Partner API account is a special type of account used solely to access Partner API. Such type of account can not be used to log into KA. And vice versa: your account for logging into KA (Client's or Reseller's) can not be used to access Partner API.