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.

Child pages
  • cPanel API 2 Functions - Mime::listmime
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Current »


This function lists Apache MIME types.


We strongly recommend that you use the following UAPI function instead of this function:


cPanel & WHM version 60 or later does not list PHP versions with MIME types when the user or domain enables PHP-FPM. The system displays only the custom MIME types that you or third parties added.


In cPanel & WHM version 76 and later, when you disable the WebServer role, the system disables this function. For more information, read our How to Use Server Profiles documentation.




 For more information, read our Calls from the WHM API documentation.

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
// List mime types associated with Apache
$list_mime = $cpanel->api2(
    'Mime', 'listmime', 
        'system'     => 'no',


For more information, read our Guide to the LiveAPI System.


 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
# List mime types associated with Apache
my $list_mime = $cpliveapi->api2(
    'Mime', 'listmime',
        'system'     => 'no',


For more information, read our Guide to the LiveAPI System.


 cPanel Tag System (deprecated)


  • 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. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
  • cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
  • For more information, read our Deprecated cPanel Tag Usage documentation.

 Command Line
cpapi2 --user=username Mime listmime system=no


  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi2 command:


 Output (JSON)
  "cpanelresult": {
    "apiversion": 2,
    "func": "listmime",
    "data": [
        "extension": ".hat",
        "origin": "user",
        "type": "hat/silly",
        "ext": ".hat"
    "event": {
      "result": 1
    "module": "Mime"


Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.


ParameterTypeDescriptionPossible valuesExample

Whether to show system-defined MIME types.

This parameter defaults to yes.

  • yes — Show all MIME types.
  • no — Show only user-defined MIME types.

Whether to show user-defined MIME types.

This parameter defaults to yes .

  • yes — Show all MIME types.
  • no — Show only system-defined MIME types.


Return TypeDescriptionPossible valuesExample
extensionstringThe file extension.

A valid file extension.

originstringWhether the MIME type is user-defined or system-defined.
  • system — System-defined MIME type.
  • user — User-defined MIME type.
typestringThe MIME type.A valid MIME type.text/plain
extstringThe file extension.A valid file extension..txt

A reason for failure.


This function only returns a reason value if it failed.

A string that describes the error.

This is an error message.

Whether the function succeeded.

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