Child pages
  • cPanel API 2 Functions - Branding::resetall

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

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

Include Page
LIB:_cPanelAPI2BrandingNote
LIB:_cPanelAPI2BrandingNote

Include Page
LIB:_cPanelAPI2NoEquivalent
LIB:_cPanelAPI2NoEquivalent

 

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleWHM API (JSON)
Code Block
languagetext
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

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink

Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Reset branding items.
$reset_items = $cpanel->api2(
    'Branding', 'resetall'
 );

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Reset branding items.
my $reset_items = $cpliveapi->api2(
    'Branding', 'resetall',
 );

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning

Expand
titleCommand Line
Code Block
languagebash
cpapi2 --user=username Branding resetall

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
  "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"
  }
}

Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote

 

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample

file

stringThe updated branding item.The name of a dynamicui.conf item.addondomain
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1