Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function converts and migrates a Legacy Backup system to the Backup system.

Examples


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/convert_and_migrate_from_legacy_config?api.version=1&no_convert=1
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/convert_and_migrate_from_legacy_config?api.version=1&no_convert=1
 Command Line
whmapi1 convert_and_migrate_from_legacy_config no_convert=1

Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command. 
  • We introduced this functionality in cPanel & WHM version 11.52.0.8.

 Output (JSON)
{  
   "metadata":{  
      "result":1,
      "version":1,
      "reason":"Legacy Backup configuration was renamed from /etc/cpbackup.conf to /etc/cpbackup.conf-1485958451 as a backup copy for your records.",
      "command":"convert_and_migrate_from_legacy_config"
   }
}
 Output (XML)
<result>
    <metadata>
        <command>convert_and_migrate_from_legacy_config</command>
        <reason>Legacy Backup configuration was renamed from /etc/cpbackup.conf to /etc/cpbackup.conf-1485958565 as a backup copy for your records.</reason>
        <result>1</result>
        <version>1</version>
    </metadata>
</result>

Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

   

Parameters

ParameterType

 

Possible valuesExample
no_convertBoolean

Optional

Whether the system converts your server from Legacy Backup to the Backup system.

1 — Conversion enabled.

0 — Conversion disabled.

1

 


Returns

This function returns only metadata.

  • No labels