We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

Developer Documentation
Child pages
  • WHM API 1 Functions - remove_logo
Skip to end of metadata
Go to start of metadata

Guide to WHM API 1

Return Data

Filter Output

Sort Output

Paginate Output

Output Columns

Call cPanel API 2 and UAPI


 cPanel Analytics

participate_in_analytics

Description


This function removes an existing logo or favicon.

Examples 

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


Notes:

  • Unless otherwise noted, 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": "remove_logo"
  }
}
 Output (XML)
<result>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>remove_logo</command>
    </metadata>
</result>


Note:

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


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.

Note:

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

logo.png

Returns

ParametersTypeDescriptionPossible valuesExample
systemstring

An error message.

Note:

The function returns this value if the logo file does not exist. Otherwise, the function only returns metadata.

A valid error message.
 Click to view...
"/var/cpanel/customizations/brand/logo.png” does not exist.

Function information

API Version:

WHM API 1

Available in:

WHM 11.48+

Methods:

GET, POST

Required Parameters:

logo_file

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

Notes:

  • Some functions and parameters may require that you authenticate as the root user.
  • You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.
  

Find a function

Related functions