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

Description

This function saves the server's custom style. You can retrieve the custom style through WHM's Customization  interface (Home >> cPanel >> Customization) or with WHM API 1's  load_style function.

Notes:

  • In cPanel & WHM version 58 to 11.48, WHM's Customization interface (Home >> cPanel >> Customization) was the Branding interface (Home >> cPanel >> Branding).
  • In cPanel & WHM version 11.48 and earlier, WHM's Branding interface (Home >> cPanel >> Branding) was the Customize Paper Lantern interface (Home >> cPanel >> Customize Paper Lantern). 

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/save_style?api.version=1&company_name=Example%20Corporation&documentation_url=http%3A%2F%2Fexample.com%2Fdocumentation%2F&help_url=http%3A%2F%2Fexample.com%2Fhelp%2F
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/save_style?api.version=1&company_name=Example%20Corporation&documentation_url=http%3A%2F%2Fexample.com%2Fdocumentation%2F&help_url=http%3A%2F%2Fexample.com%2Fhelp%2F
 Command Line
whmapi1 save_style company_name="Example Corporation" documentation_url=http%3A%2F%2Fexample.com%2Fdocumentation%2F help_url=http%3A%2F%2Fexample.com%2Fhelp%2F


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)
{
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "save_style"
  }
}
 Output (XML)
<result>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>save_style</command>
    </metadata>
</result>


Note:

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

   

Parameters

ParameterTypeDescriptionPossible valuesExample
company_name
stringThe company name.A valid string.Example Corporation
documentation_urlstringThe reseller's documentation URL.A valid URL.http://example.com/documentation/
help_urlstringThe reseller's help URL.A valid URL.http://example.com/help/

Returns

This function only returns metadata.