Description
This function resets the branding package's HTML files.
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=resethtml
LiveAPI PHP Class
$cpanel = new CPANEL();
$reset_items = $cpanel->api2(
'Branding', 'resethtml'
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $reset_items = $cpliveapi->api2(
'Branding', 'resethtml',
);
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 resethtml
|
Output (JSON)
{
"cpanelresult": {
"apiversion": 2,
"func": "resethtml",
"data": [
{
"file": "contactinfo_include.html"
},
{
"file": "cpanel_parsed_css.html"
},
{
"file": "cpanel_parsed_css_local.html"
},
{
"file": "extended_statsbar.html"
},
{
"file": "getstarted-pop.html"
},
{
"file": "index.html"
},
{
"file": "optionselect-pop.html"
},
{
"file": "publiccontact_include.html"
},
{
"file": "sprites.html"
},
{
"file": "sprites_ui.html"
},
{
"file": "sprites_yui.html"
},
{
"file": "stdfooter.html"
},
{
"file": "stdheader.html"
},
{
"file": "stdmheader.html"
},
{
"file": "supportinfo_include.html"
},
{
"file": "webmaillogininclude.html"
}
],
"event": {
"result": 1
},
"module": "Branding"
}
}
Parameters
This function does not accept parameters.
Returns
|
Return
|
Type
|
Description
|
Possible values
|
Example
|
|
file
|
string
|
The updated HTML file.
|
An HTML file's name.
|
contactinfo_include.html
|
|
result
|
Boolean
|
Whether the function succeeded.
|
- 1 — The function succeeded.
- 0 — The function failed.
|
1
|
