plesk / api-examples

Plesk API-RPC usage examples

Plesk API-RPC Usage Examples

Repository contains the examples on how to use Plesk API-RPC using different programming languages. Here you can find useful helpers to execute API-RPC requests.

Languages

• Bash
• C++
• C#
• Go
• Java
• Node.js
• Objective-C
• PHP
• Python
• Ruby
• Visual Basic

How to Run

To run the example use the following command:

REMOTE_HOST=your-plesk-host.dom REMOTE_LOGIN=admin REMOTE_PASSWORD=password ./example.py

Plain Text Examples

Plain text examples of possible requests and responses: http://plesk.github.io/api-examples/

Documentation

• Official XML API documentation
• Interactive schemas of XML-RPC packets structure

api-examples's Issues

No 'Access-Control-Allow-Origin'

Hello Plesk-Team,

thank you for your great software.
I want to connect to plesk with my nodejs app.
But I get the following error.
I followed the plesk documentation to enable api access in the panel.ini but with no success.
Do you have a solution for this?

Failed to load https://domain:8443/enterprise/control/agent.php: Response to preflight request doesn't pass access control check: No 'Access-Control-Allow-Origin' header is present on the requested resource. Origin 'http://domain' is therefore not allowed access. If an opaque response serves your needs, set the request's mode to 'no-cors' to fetch the resource with CORS disabled.

https://docs.plesk.com/de-DE/onyx/administrator-guide/plesk-administration/absichern-von-plesk/restricting-remote-access-via-plesk-api.71930/

Kind regards

Adding Subscriptions - 502 Bad Gateway

This work great but when adding subscription the server returns 502 Bad Gateway instead of xml response.

Bash example does not Work

Hi,
tried your code example for bash, but following error occurs:
/API# ls -l
total 8
-rwxr-xr-x 1 root root 200 Jun 1 08:47 example.sh
-rwxr-xr-x 1 root root 369 Jun 1 08:43 plesk_api_client.sh

REMOTE_HOST=xxx REMOTE_LOGIN=admin REMOTE_PASSWORD=xx ./example.sh
./example.sh: 4: .: plesk_api_client.sh: not found

What Am I doing wrong?

Getting error "Authentication method not specified" when trying samples

When I attempt to make a request to the Plesk XML API, i get the following error:

<?xml version="1.0"?>
<packet version="1.6.9.1">
    <system>
        <status>error</status>
        <errcode>1029</errcode>
        <errtext>Authentication method is not specified</errtext>
    </system>
</packet>

My Request looks like this:

<packet>
<customer>
   <get>
      <filter />
      <dataset>
          <gen_info/>
          <stat/>
      </dataset>
   </get>
</customer>
</packet>

And I am setting the following headers:

1. HTTP_AUTH_LOGIN
2. HTTP_AUTH_PASSWORD
3. Content-Type

Am I missing something?