restore_modules_summary

This function lists backup modules and their descriptions.

Authorizations:

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 restore_modules_summary

Response samples

Content type
application/json
{
  • "data": {
    • "modules": [
      • {
        • "module": "Account",
        • "notes": [
          • "This restores all of the privileges the account previously had, including the “all” privilege which is equivalent to root access."
          ],
        • "restricted_available": 1,
        • "restricted_summary": [
          • "Force mode is not available in restricted mode."
          ],
        • "summary": [
          • "This creates the cPanel account and system user."
          ]
        }
      ]
    },
  • "metadata": {
    • "command": "restore_modules_summary",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}