Child pages
  • WHM API 1 Functions - restore_modules_summary
Skip to end of metadata
Go to start of metadata

Description

This function lists backup modules and their descriptions.

Examples


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


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.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{  
   "data":{  
      "modules":[  
         {  
            "summary":[  
               "This creates the cPanel account and system user."
            ],
            "restricted_available":1,
            "restricted_summary":[  
               "Force mode is not available in restricted mode."
            ],
            "module":"Account"
         },
         {  
            "summary":[  
               "This installs the backup configuration based on the target system's defaults."
            ],
            "restricted_available":1,
            "module":"BackupConfig"
         },
         {  
            "summary":[  
               "This restores web counter counts."
            ],
            "restricted_available":1,
            "module":"Counter"
         },
         {  
            "summary":[  
               "This restores the cPanel account's configuration data."
            ],
            "restricted_available":1,
            "restricted_summary":[  
               "The system discards configuration data that is unknown or that the system cannot validate."
            ],
            "module":"CpUser"
         },
         {  
            "summary":[  
               "This restores crontab entries."
            ],
            "restricted_available":1,
            "module":"Cron"
         },
         {  
            "summary":[  
               "This restores custom locales."
            ],
            "restricted_available":0,
            "module":"CustomLocale"
         },
         {  
            "summary":[  
               "This restores DKIM (DomainKeys Identified Mail) keys and updates records for the current server."
            ],
            "restricted_available":1,
            "module":"DKIM"
         },
         {  
            "summary":[  
               "This restores password data for digest authentication."
            ],
            "restricted_available":1,
            "module":"DigestShadow"
         },
         {  
            "summary":[  
               "This restores subdomains, parked domains, and addon domains."
            ],
            "restricted_available":1,
            "module":"Domains"
         },
         {  
            "summary":[  
               "This restores the account's feature list setting."
            ],
            "restricted_available":1,
            "module":"FeatureList"
         },
         {  
            "summary":[  
               "This configures the account for cPanel FileProtect."
            ],
            "restricted_available":1,
            "module":"FileProtect"
         },
         {  
            "summary":[  
               "This restores FTP (File Transfer Protocol) accounts."
            ],
            "restricted_available":1,
            "module":"Ftp"
         },
         {  
            "summary":[  
               "This restores the home directory's contents."
            ],
            "restricted_available":1,
            "restricted_summary":[  
               "If the home directory does not already exist, the system will not create it."
            ],
            "module":"Homedir"
         },
         {  
            "summary":[  
               "This restores Horde configuration and preferences."
            ],
            "restricted_available":1,
            "module":"Horde"
         },
         {  
            "summary":[  
               "This removes legacy Frontpage entries from .htaccess."
            ],
            "restricted_available":1,
            "module":"Htaccess"
         },
         {  
            "summary":[  
               "This sets up a dedicated IP address."
            ],
            "restricted_available":1,
            "module":"IPAddress"
         },
         {  
            "summary":[  
               "This restores service access logs."
            ],
            "restricted_available":1,
            "module":"Logs"
         },
         {  
            "summary":[  
               "This resets email quotas to safe values and restores email aliases and filters."
            ],
            "restricted_available":1,
            "module":"Mail"
         },
         {  
            "summary":[  
               "This repairs mail permissions and upgrades the system to the latest storage methods."
            ],
            "restricted_available":1,
            "module":"MailFix"
         },
         {  
            "summary":[  
               "This updates MX (Mail eXchange) records."
            ],
            "restricted_available":1,
            "module":"MailRouting"
         },
         {  
            "summary":[  
               "This restores mailing lists."
            ],
            "restricted_available":1,
            "module":"Mailman"
         },
         {  
            "summary":[  
               "This restores MariaDB/MySQL databases, users, and grants."
            ],
            "restricted_available":1,
            "module":"Mysql"
         },
         {  
            "summary":[  
               "This restores ownership of files previously owned by the "nobody" user in the home directory."
            ],
            "restricted_available":1,
            "module":"NobodyFiles"
         },
         {  
            "summary":[  
               "This creates symbolic links to former home directory paths."
            ],
            "notes":[  
               "Symbolic links for former home directories ensure that applications with hard-coded paths continue to work when transferred between servers."
            ],
            "restricted_available":0,
            "module":"OldHomedirs"
         },
         {  
            "summary":[  
               "This recreates account packages."
            ],
            "notes":[  
               "If the target server does not have the package that the user has been assigned, the system will use the account's properties to recreate the package."
            ],
            "restricted_available":0,
            "module":"Package"
         },
         {  
            "summary":[  
               "This restores the encrypted system password."
            ],
            "restricted_available":1,
            "module":"Password"
         },
         {  
            "summary":[  
               "This runs post-restoration actions and cleanups."
            ],
            "notes":[  
               "This module updates system databases and name server IP address lists, restarts services, unblocks dynamic content, and runs custom post-restoration scripts."
            ],
            "restricted_available":1,
            "module":"PostRestoreActions"
         },
         {  
            "summary":[  
               "This restores PostgreSQL databases, users, and grants."
            ],
            "restricted_available":1,
            "restricted_summary":[  
               "PostgreSQL version "8.4" or later is required to restore databases in restricted mode."
            ],
            "module":"Postgres"
         },
         {  
            "summary":[  
               "This performs pre-restoration actions and cleanups."
            ],
            "notes":[  
               "This module temporarily lifts the account's quota and runs custom pre-restoration scripts."
            ],
            "restricted_available":1,
            "module":"PreRestoreActions"
         },
         {  
            "summary":[  
               "This restores proxy subdomains."
            ],
            "notes":[  
               "This module ensures that proxy subdomains such as "cpanel", "webmail", "webdisk", and "autoconfig" are configured properly."
            ],
            "restricted_available":1,
            "module":"ProxySubdomains"
         },
         {  
            "summary":[  
               "This creates symbolic links to former web root directory paths."
            ],
            "notes":[  
               "Symbolic links for former web root directories ensure that applications with hard-coded paths will continue to work when transferred between servers."
            ],
            "restricted_available":1,
            "restricted_summary":[  
               "The system does not recreate symbolic links outside of the account's home directory in restricted mode."
            ],
            "module":"PublicHtmlSymlinks"
         },
         {  
            "summary":[  
               "This restores the account's data storage quota."
            ],
            "restricted_available":1,
            "module":"Quota"
         },
         {  
            "summary":[  
               "This restores reseller privileges."
            ],
            "notes":[  
               "This restores all of the privileges the account previously had, including the "all" privilege which is equivalent to root access."
            ],
            "restricted_available":0,
            "module":"Reseller"
         },
         {  
            "summary":[  
               "This restores Roundcube configuration and preferences."
            ],
            "restricted_available":1,
            "module":"Roundcube"
         },
         {  
            "summary":[  
               "This restores SPF (Sender Policy Framework) records and updates them for the target server."
            ],
            "restricted_available":1,
            "module":"SPF"
         },
         {  
            "summary":[  
               "This restores SSL (Secure Sockets Layer) keys, certificates, and virtual host entries."
            ],
            "restricted_available":1,
            "module":"SSL"
         },
         {  
            "summary":[  
               "This restores the account's shell."
            ],
            "restricted_available":1,
            "restricted_summary":[  
               "In restricted mode, the system will set any account that requests a shell other than "jailshell" or "noshell" to use "noshell"."
            ],
            "module":"Shell"
         },
         {  
            "summary":[  
               "This restores Tomcat data."
            ],
            "restricted_available":1,
            "module":"Tomcat"
         },
         {  
            "summary":[  
               "This unsuspends .htaccess files."
            ],
            "restricted_available":1,
            "module":"Unsuspend"
         },
         {  
            "summary":[  
               "This restores custom virtual host includes."
            ],
            "restricted_available":0,
            "module":"VhostIncludes"
         },
         {  
            "summary":[  
               "This rewrites web disk home directories to the correct location on the new server."
            ],
            "restricted_available":1,
            "module":"WebDiskHomedir"
         },
         {  
            "summary":[  
               "This restores custom DNS (Domain Name System) Zone entries."
            ],
            "restricted_available":1,
            "module":"ZoneFile"
         },
         {  
            "summary":[  
               "This restores website configuration (userdata)."
            ],
            "restricted_available":1,
            "restricted_summary":[  
               "Restricted Restore does not restore the entire userdata file; instead, the system will create a new one and copy in certain information. Customizations to the userdata file in the archive will not be in the newly-created userdata file."
            ],
            "module":"userdata"
         }
      ]
   },
   "metadata":{  
      "version":1,
      "reason":"OK",
      "result":"1",
      "command":"restore_modules_summary"
   }
}
 Output (XML)
<result>
    <data>
        <modules>
            <summary>This creates the cPanel account and system user.</summary>
            <restricted_available>1</restricted_available>
            <restricted_summary>Force mode is not available in restricted mode.</restricted_summary>
            <module>Account</module>
        </modules>
        <modules>
            <summary>This installs the backup configuration based on the target system&#x2019;s defaults.</summary>
            <restricted_available>1</restricted_available>
            <module>BackupConfig</module>
        </modules>
        <modules>
            <summary>This restores web counter counts.</summary>
            <restricted_available>1</restricted_available>
            <module>Counter</module>
        </modules>
        <modules>
            <summary>This restores the cPanel account&#x2019;s configuration data.</summary>
            <restricted_available>1</restricted_available>
            <restricted_summary>The system discards configuration data that is unknown or that the system cannot validate.</restricted_summary>
            <module>CpUser</module>
        </modules>
        <modules>
            <summary>This restores crontab entries.</summary>
            <restricted_available>1</restricted_available>
            <module>Cron</module>
        </modules>
        <modules>
            <summary>This restores custom locales.</summary>
            <restricted_available>0</restricted_available>
            <module>CustomLocale</module>
        </modules>
        <modules>
            <summary>This restores DKIM (DomainKeys Identified Mail) keys and updates records for the current server.</summary>
            <restricted_available>1</restricted_available>
            <module>DKIM</module>
        </modules>
        <modules>
            <summary>This restores password data for digest authentication.</summary>
            <restricted_available>1</restricted_available>
            <module>DigestShadow</module>
        </modules>
        <modules>
            <summary>This restores subdomains, parked domains, and addon domains.</summary>
            <restricted_available>1</restricted_available>
            <module>Domains</module>
        </modules>
        <modules>
            <summary>This restores the account&#x2019;s feature list setting.</summary>
            <restricted_available>1</restricted_available>
            <module>FeatureList</module>
        </modules>
        <modules>
            <summary>This configures the account for cPanel FileProtect.</summary>
            <restricted_available>1</restricted_available>
            <module>FileProtect</module>
        </modules>
        <modules>
            <summary>This restores FTP (File Transfer Protocol) accounts.</summary>
            <restricted_available>1</restricted_available>
            <module>Ftp</module>
        </modules>
        <modules>
            <summary>This restores the home directory&#x2019;s contents.</summary>
            <restricted_available>1</restricted_available>
            <restricted_summary>If the home directory does not already exist, the system will not create it.</restricted_summary>
            <module>Homedir</module>
        </modules>
        <modules>
            <summary>This restores Horde configuration and preferences.</summary>
            <restricted_available>1</restricted_available>
            <module>Horde</module>
        </modules>
        <modules>
            <summary>This removes legacy Frontpage entries from .htaccess.</summary>
            <restricted_available>1</restricted_available>
            <module>Htaccess</module>
        </modules>
        <modules>
            <summary>This sets up a dedicated IP address.</summary>
            <restricted_available>1</restricted_available>
            <module>IPAddress</module>
        </modules>
        <modules>
            <summary>This restores service access logs.</summary>
            <restricted_available>1</restricted_available>
            <module>Logs</module>
        </modules>
        <modules>
            <summary>This resets email quotas to safe values and restores email aliases and filters.</summary>
            <restricted_available>1</restricted_available>
            <module>Mail</module>
        </modules>
        <modules>
            <summary>This repairs mail permissions and upgrades the system to the latest storage methods.</summary>
            <restricted_available>1</restricted_available>
            <module>MailFix</module>
        </modules>
        <modules>
            <summary>This updates MX (Mail eXchange) records.</summary>
            <restricted_available>1</restricted_available>
            <module>MailRouting</module>
        </modules>
        <modules>
            <summary>This restores mailing lists.</summary>
            <restricted_available>1</restricted_available>
            <module>Mailman</module>
        </modules>
        <modules>
            <summary>This restores MariaDB/MySQL databases, users, and grants.</summary>
            <restricted_available>1</restricted_available>
            <module>Mysql</module>
        </modules>
        <modules>
            <summary>This restores ownership of files previously owned by the &#x201C;nobody&#x201D; user in the home directory.</summary>
            <restricted_available>1</restricted_available>
            <module>NobodyFiles</module>
        </modules>
        <modules>
            <summary>This creates symbolic links to former home directory paths.</summary>
            <notes>Symbolic links for former home directories ensure that applications with hard-coded paths continue to work when transferred between servers.</notes>
            <restricted_available>0</restricted_available>
            <module>OldHomedirs</module>
        </modules>
        <modules>
            <summary>This recreates account packages.</summary>
            <notes>If the target server does not have the package that the user has been assigned, the system will use the account&#x2019;s properties to recreate the package.</notes>
            <restricted_available>0</restricted_available>
            <module>Package</module>
        </modules>
        <modules>
            <summary>This restores the encrypted system password.</summary>
            <restricted_available>1</restricted_available>
            <module>Password</module>
        </modules>
        <modules>
            <summary>This runs post-restoration actions and cleanups.</summary>
            <notes>This module updates system databases and name server IP address lists, restarts services, unblocks dynamic content, and runs custom post-restoration scripts.</notes>
            <restricted_available>1</restricted_available>
            <module>PostRestoreActions</module>
        </modules>
        <modules>
            <summary>This restores PostgreSQL databases, users, and grants.</summary>
            <restricted_available>1</restricted_available>
            <restricted_summary>PostgreSQL version &#x201C;8.4&#x201D; or later is required to restore databases in restricted mode.</restricted_summary>
            <module>Postgres</module>
        </modules>
        <modules>
            <summary>This performs pre-restoration actions and cleanups.</summary>
            <notes>This module temporarily lifts the account&#x2019;s quota and runs custom pre-restoration scripts.</notes>
            <restricted_available>1</restricted_available>
            <module>PreRestoreActions</module>
        </modules>
        <modules>
            <summary>This restores proxy subdomains.</summary>
            <notes>This module ensures that proxy subdomains such as &#x201C;cpanel&#x201D;, &#x201C;webmail&#x201D;, &#x201C;webdisk&#x201D;, and &#x201C;autoconfig&#x201D; are configured properly.</notes>
            <restricted_available>1</restricted_available>
            <module>ProxySubdomains</module>
        </modules>
        <modules>
            <summary>This creates symbolic links to former web root directory paths.</summary>
            <notes>Symbolic links for former web root directories ensure that applications with hard-coded paths will continue to work when transferred between servers.</notes>
            <restricted_available>1</restricted_available>
            <restricted_summary>The system does not recreate symbolic links outside of the account&#x2019;s home directory in restricted mode.</restricted_summary>
            <module>PublicHtmlSymlinks</module>
        </modules>
        <modules>
            <summary>This restores the account&#x2019;s data storage quota.</summary>
            <restricted_available>1</restricted_available>
            <module>Quota</module>
        </modules>
        <modules>
            <summary>This restores reseller privileges.</summary>
            <notes>This restores all of the privileges the account previously had, including the &#x201C;all&#x201D; privilege which is equivalent to root access.</notes>
            <restricted_available>0</restricted_available>
            <module>Reseller</module>
        </modules>
        <modules>
            <summary>This restores Roundcube configuration and preferences.</summary>
            <restricted_available>1</restricted_available>
            <module>Roundcube</module>
        </modules>
        <modules>
            <summary>This restores SPF (Sender Policy Framework) records and updates them for the target server.</summary>
            <restricted_available>1</restricted_available>
            <module>SPF</module>
        </modules>
        <modules>
            <summary>This restores SSL (Secure Sockets Layer) keys, certificates, and virtual host entries.</summary>
            <restricted_available>1</restricted_available>
            <module>SSL</module>
        </modules>
        <modules>
            <summary>This restores the account&#x2019;s shell.</summary>
            <restricted_available>1</restricted_available>
            <restricted_summary>In restricted mode, the system will set any account that requests a shell other than &#x201C;jailshell&#x201D; or &#x201C;noshell&#x201D; to use &#x201C;noshell&#x201D;.</restricted_summary>
            <module>Shell</module>
        </modules>
        <modules>
            <summary>This restores Tomcat data.</summary>
            <restricted_available>1</restricted_available>
            <module>Tomcat</module>
        </modules>
        <modules>
            <summary>This unsuspends .htaccess files.</summary>
            <restricted_available>1</restricted_available>
            <module>Unsuspend</module>
        </modules>
        <modules>
            <summary>This restores custom virtual host includes.</summary>
            <restricted_available>0</restricted_available>
            <module>VhostIncludes</module>
        </modules>
        <modules>
            <summary>This rewrites web disk home directories to the correct location on the new server.</summary>
            <restricted_available>1</restricted_available>
            <module>WebDiskHomedir</module>
        </modules>
        <modules>
            <summary>This restores custom DNS (Domain Name System) Zone entries.</summary>
            <restricted_available>1</restricted_available>
            <module>ZoneFile</module>
        </modules>
        <modules>
            <summary>This restores website configuration (userdata).</summary>
            <restricted_available>1</restricted_available>
            <restricted_summary>Restricted Restore does not restore the entire userdata file; instead, the system will create a new one and copy in certain information. Customizations to the userdata file in the archive will not be in the newly-created userdata file.</restricted_summary>
            <module>userdata</module>
        </modules>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>restore_modules_summary</command>
    </metadata>
</result>


Note:

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

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
modulesarray of hashesAn array of hashes that contain information about backup configuration modules.This array includes the module, summary, restricted_summary, notes, and restricted_available returns.
 

module

string

The module's name.

The function returns this value in the modules array.

A valid string.

Account

notes

array

Notes about the module.

The function returns this value in the modules array.

A valid string.
This restores all of the privileges the account previously had, including the &#x201C;all&#x201D; privilege which is equivalent to root access.

summary

array

A description of the module's behavior if the transfer does not use restricted restore.

The function returns this array in the modules array.

A valid string.
This creates the cPanel account and system user.

restricted_summary

array

A description of the module's behavior if the transfer uses restricted restore.

The function returns this array in the modules array.

A valid string.
Force mode is not available in restricted mode.

restricted_available

Boolean

Whether the module is available in restricted restore.

The function returns this array in the modules array.

  • 1 — The module is available under restricted restore.
  • 0 — The module is not available under restricted restore.
1