cPanel API 2 Functions - Mime::listhandlers - Knowledgebase

Description

This function lists Apache's handlers.

Warning:

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

Mime::list_handlers — This function lists all of Apache's MIME handlers.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Mime&cpanel_jsonapi_func=listhandlers&system=no

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// List handlers associated with Apache
$list_handlers = $cpanel->api2(
    'Mime', 'listhandlers',
    array(
        'system'     => 'no',
  )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# List Apache's handlers
my $list_handlers = $cpliveapi->api2(
    'Mime', 'listhandlers',
    {
        'system'     => 'no',
 }
);

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.

 Output (JSON)

{
 "cpanelresult": {
    "apiversion": 2,
    "func": "listhandlers",
    "data": [
      {
        "extension": ".txt",
        "handler": "plain-text",
        "origin": "user",
        "ext": ".txt"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Mime"
  }
}

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
system	string	Whether to show system-defined MIME types.	yes — Show all MIME types. no — Show only user-defined MIME types.	no
user	string	Whether to show user-defined MIME types.	yes — Show all MIME types. no — Show only system-defined MIME types.	no

Returns

Return	Type	Description	Possible values	Example
extension	string	The file extension.	A valid file extension.	.txt
handler	string	The name of the handler.	A valid Apache handler type, which contains a hyphen.	plain-text
origin	string	Whether the handler is user-defined or system-defined.	user system	user
ext	string	The file extension.	A valid file extension.	.txt
reason	string	A reason for failure. Note: This function only returns areason value if it failed.	A string that describes the error.	This is an error message.
result	boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories