Forwarded to devs XML API backup-manager operator does not work

[Mag Serv]

TITLE:

XML API backup-manager operator does not work​

PRODUCT, VERSION, OPERATING SYSTEM, ARCHITECTURE:

Product version: Plesk Obsidian 18.0.20.2
OS version: Ubuntu 18.04 x86_64
Build date: 2019/11/01 13:00
Revision: 8990d615e1ba3c129f3e9a49ad9a3ff28d99aa08​

PROBLEM DESCRIPTION:

We have been trying to manage backups using the XML API, but cannot get the backup-manager operator to work (Managing Backups).​

STEPS TO REPRODUCE:

Create a file backupmanager.get-local-backup-list, with the following contents:
<packet>
<backup-manager>
<get-local-backup-list>
<server/>
</get-local-backup-list>
</backup-manager>
</packet>

Execute:
curl -L -H "Content-Type: text/xml" -H "KEY: <secret key>" -H "HTTP_PRETTY_PRINT: TRUE" -d @backupmanager.get-local-backup-list https://<hostname>:8443/enterprise/control/agent.php​

ACTUAL RESULT:

<?xml version="1.0"?>
<packet version="1.6.9.1">
<system>
<status>error</status>
<errcode>1014</errcode>
<errtext>Parser error: Request is invalid. Error in line 1: Element 'backup-manager': This element is not expected. Expected is one of ( request-settings, server, customer, webspace, subdomain, dns, db_server, mail, certificate, site-alias ).</errtext>
</system>
</packet>​

EXPECTED RESULT:

List of backups sent in an XML packet. I expected a result similar to that given in the documentation (Retrieving a List of Local Backups):
<packet version="1.6.7.0">
<backup-manager>
<get-local-backup-list>
<result>
<status>ok</status>
<backup>
<file>
<name>12-11-2003-mycustomer_3_8.bak</name>
<creation-date>1179482633</creation-date>
<description/>
<size>0</size>
<not-backup/>
</file>
</backup>
<backup>
<file>
<name>priest_2007.05.18_17.12</name>
<creation-date>1179483198</creation-date>
<description>sdf backup.
Creation date: May 18, 2007 05:12 PM</description>
<size>128732</size>
</file>
</backup>
</result>
</get-local-backup-list>
</backup-manager>
</packet>​

ANY ADDITIONAL INFORMATION:

This does not work for Plesk Onyx either.​

YOUR EXPECTATIONS FROM PLESK SERVICE TEAM:

Confirm bug​

 

[IgorG]

Article 'Managing backups' read right on top:

Plesk version: Plesk 9.0.0 - Plesk Onyx 17.5

XML API version: 1.5.2.0 - 1.6.9.0

The functionality itself was dropped in 17.8.

When one uses <packet> omitting version, XML API uses the latest one which is 1.6.9.1.
Once a supported version is used in request packet on 18.0, the answer is:

<?xml version="1.0" encoding="UTF-8"?>
<packet version="1.6.7.0">
  <backup-manager>
    <get-local-backup-list>
      <result>
        <status>error</status>
        <errcode>1017</errcode>
        <errtext>This feature is no longer supported.</errtext>
      </result>
    </get-local-backup-list>
  </backup-manager>
</packet>

 

[Mag Serv]

Will you be replacing the documentation at Retrieving a List of Local Backups with a notification that the functionality has been dropped?

We can see what you mean about the Plesk and XML API version fields in the Managing Backups article showing that it is deprecated. We were relying on there only being documentation for aspects of the Obsidian XML API if they actually exist. It seems it would be better to entirely delete the sections for API operators that no longer exist; current users can always find them in the Onyx XML API docs.

When we were unable to get this functionality to work, we spent a long time looking for any sign that it was no longer supported in the docs, in particular: What’s New in This Version
Why does this seem to not have been updated since the original Onyx release?

 

[IgorG]

Will you be replacing the documentation at Retrieving a List of Local Backups with a notification that the functionality has been dropped?

Yes, I have submitted the corresponding request to Documentation Team.

 

[Mag Serv]

Thanks, there is now a warning on the API page warning that it is deprecated.
Will What’s New in This Version be updated also?

 

[IgorG]

Will What’s New in This Version be updated also?

Yes, we will fix this page too. Thanks.

 

[Vikelidis Kostas]

Does this mean that there is no way to retrieve the list of backups in the latest version (Obsidian) of Plesk?

Is there any other API call to retrieve this information?

 

[IgorG]

Does this mean that there is no way to retrieve the list of backups in the latest version (Obsidian) of Plesk?

Is there any other API call to retrieve this information?

Look at the features of Plesk REST API, especially the ability to run command line utilities.

 

[occinodo]

Hi Igor, I have checked this extensively, but from what I can tell there is no way using either the API or command line (which in turn could be used in the API) to display a list of all back-ups.