Plesk Multi Server API Reference

You can perform all API calls through the management node as a single entry point. Plesk Multi Server API-RPC is compatible with the Plesk's XML API.

Working with Plesk Multi Server API

Plesk Multi Server API operations allow to manage the service nodes. Use Plesk Multi Server API to manage service nodes:

Provisioning is performed asynchronously in Plesk Multi Server. While an API call is executed immediately, the corresponding provisioning tasks continue to execute on the service nodes. Manage provisioning tasks using Plesk Multi Server API:

Packets for Plesk Multi Server API follow this structure:

<packet>
  <extension>
    <call>
      <plesk-multi-server>
		...
      </plesk-multi-server>
    </call>
  </extension>
</packet>

Working with Plesk API Through Plesk Multi Server

Requests to Plesk API for operations related to Multi Server must be sent through Multi Server API. This way, Plesk Multi Server extension can perform necessary operations, based on the sent request, or simply forward it to Plesk if no additional operations on the Plesk Multi Server side are required. This approach must be used for operations like:

Packets for Plesk API that are forwarded through Plesk Multi Server follow this structure:

<packet>
  <request-settings>
    <setting>
      <name>plesk_rpc_forwarding_to_ext</name>
      <value>plesk-multi-server</value>
    </setting>
  </request-settings>
	...
  (main_request)
	...
</packet>

For the information on Plesk API, see Plesk XML API Guide.

  

Next in this section:

Listing Connected Service Nodes

Connecting New Service Node

Deleting Connected Service Nodes

Setting Service Node Status

Issuing New Secret Key for Service Node

Retrieving Last Provisioning Task ID

Listing Provisioning Tasks

Getting Task Status

Working with Custom Balancers

Creating Customer Accounts

Creating New Subscriptions

Creating New Domains

 

Leave your feedback on this topic here

If you have questions or need support, please visit the Plesk forum or contact your hosting provider.
The comments below are for feedback on the documentation only. No timely answers or help will be provided.