Description

This function removes an existing logo or favicon.

Examples 


https://hostname.example.com:2087/cpsess##########/json-api/remove_logo?api.version=1&logo_file=logo.png
https://hostname.example.com:2087/cpsess##########/xml-api/remove_logo?api.version=1&logo_file=logo.png
whmapi1 remove_logo logo_file=logo.png

{
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "remove_logo"
  }
}
<result>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>remove_logo</command>
    </metadata>
</result>

 

Parameters

ParametersTypeDescriptionPossible valuesExample
logo_filestring

Required

The file type to remove.

  • logo.png — Remove a .png cPanel logo file.
  • logo.svg — Remove a .svg cPanel logo file.

  • favicon.ico — Remove the favicon file.
  • webmail.png — Remove a .png Webmail logo file.
  • webmail.svg — Remove a .svg Webmail logo file.

We added support for SVG logos in cPanel & WHM version 60.

logo.png

Returns

This function only returns metadata.