cPanel API 2 Functions - Branding::resetall - Knowledgebase

Description

This function resets all of the dynamicui.conf file's items.

Note:

cPanel API 2's Branding module only modifies data for the x3 theme.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Branding&cpanel_jsonapi_func=resetall

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Reset branding items.

$reset_items = $cpanel->api2(

'Branding', 'resetall'

);

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Reset branding items.

my $reset_items = $cpliveapi->api2(

'Branding', 'resetall',

);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

Command Line

cpapi2 --user=username Branding resetall

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "resetall",
    "data": [
      {
        "file": "addondomain"
      },
      {
        "file": "analogstats"
      },
      {
        "file": "anonymousmsg"
      },
      {
        "file": "apache"
      },
      {
        "file": "awstats"
      },
      {
        "file": "backup-wizard"
      },
      {
        "file": "boxtrapper"
      },
      {
        "file": "branding"
      },
      {
        "file": "cgi-center"
      },
      {
        "file": "changelang"
      },
      {
        "file": "chooselog"
      },
      {
        "file": "clam"
      },
      {
        "file": "cpanelAPI"
      },
      {
        "file": "cron"
      },
      {
        "file": "csvimport"
      },
      {
        "file": "defaultemailacct"
      },
      {
        "file": "dfiltering"
      },
      {
        "file": "email-reports"
      },
      {
        "file": "emailarch"
      },
      {
        "file": "emailauth"
      },
      {
        "file": "emailmx"
      },
      {
        "file": "enduserlve"
      },
      {
        "file": "errorlogs"
      },
      {
        "file": "errorpage"
      },
      {
        "file": "favorites"
      },
      {
        "file": "filemanager"
      },
      {
        "file": "forwardersemail"
      },
      {
        "file": "ftpaccounts"
      },
      {
        "file": "ftpcontrol"
      },
      {
        "file": "getstart"
      },
      {
        "file": "group_advanced"
      },
      {
        "file": "group_db"
      },
      {
        "file": "group_domains"
      },
      {
        "file": "group_files"
      },
      {
        "file": "group_logs"
      },
      {
        "file": "group_mail"
      },
      {
        "file": "group_pref"
      },
      {
        "file": "group_sec"
      },
      {
        "file": "group_software"
      },
      {
        "file": "hd"
      },
      {
        "file": "hdspace"
      },
      {
        "file": "hotlinkprotect"
      },
      {
        "file": "image-manager"
      },
      {
        "file": "index"
      },
      {
        "file": "ipdeny"
      },
      {
        "file": "keys"
      },
      {
        "file": "latestvisitors"
      },
      {
        "file": "leechprotect"
      },
      {
        "file": "legacy_filemanager"
      },
      {
        "file": "lookandfeel"
      },
      {
        "file": "maillist"
      },
      {
        "file": "manageaccounts"
      },
      {
        "file": "mime-types"
      },
      {
        "file": "mod_security"
      },
      {
        "file": "mysql"
      },
      {
        "file": "mysql-remoteaccess"
      },
      {
        "file": "mysql-wizard3"
      },
      {
        "file": "nettools"
      },
      {
        "file": "networkmonitor"
      },
      {
        "file": "optimizews"
      },
      {
        "file": "parkeddomains"
      },
      {
        "file": "password"
      },
      {
        "file": "password-protect"
      },
      {
        "file": "perl"
      },
      {
        "file": "php"
      },
      {
        "file": "php-pear"
      },
      {
        "file": "phpMyAdmin"
      },
      {
        "file": "phpPgAdmin"
      },
      {
        "file": "postgresql"
      },
      {
        "file": "postgresql-wizard"
      },
      {
        "file": "rails"
      },
      {
        "file": "rawaccesslogs"
      },
      {
        "file": "redirects"
      },
      {
        "file": "responder"
      },
      {
        "file": "ruby"
      },
      {
        "file": "scripts-library"
      },
      {
        "file": "sec_policy"
      },
      {
        "file": "simplezoneedit"
      },
      {
        "file": "spamassassin"
      },
      {
        "file": "ssh-shell-access"
      },
      {
        "file": "ssl-manager"
      },
      {
        "file": "subdomains"
      },
      {
        "file": "submit-support"
      },
      {
        "file": "tutorials"
      },
      {
        "file": "updatecontact"
      },
      {
        "file": "urchin"
      },
      {
        "file": "userfiltering"
      },
      {
        "file": "webalizerftp"
      },
      {
        "file": "webalizerlog"
      },
      {
        "file": "webdav"
      },
      {
        "file": "webemail"
      },
      {
        "file": "whm"
      },
      {
        "file": "zoneedit"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Branding"
  }
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
file	string	The updated branding item.	The name of a dynamicui.conf item.	addondomain
result	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories