# cPanel API 2 Functions - Mime::listhandlers

Warning:
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](https://api.docs.cpanel.net/cpanel/introduction) instead of cPanel API 2.

## Description

This function lists Apache's handlers.

Warning:
We **strongly** recommend that you use the following [UAPI](/cpanel/introduction/) function instead of this function:

- [`Mime::list_handlers`](/openapi/cpanel/operation/list_handlers/)


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

Important:
When you disable the [*Web Server* role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.

## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
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
```

Note:
For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

LiveAPI PHP Class


```undefined syntaxhighlighter-pre
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// List handlers associated with Apache
$list_handlers = $cpanel->api2(
    'Mime', 'listhandlers',
    array(
        'system'     => 'no',
  )
);
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

LiveAPI Perl Module


```undefined syntaxhighlighter-pre
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',
 }
);
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

cPanel Tag System (deprecated)

Warnings:
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) 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](/guides/guide-to-the-liveapi-system).
- 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](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage) documentation.


Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username Mime listhandlers system=no
```

div
Notes:

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

```undefined syntaxhighlighter-pre
/usr/local/cpanel/bin/cpapi2
```


br
Output (JSON)


```undefined syntaxhighlighter-pre
{
 "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*](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel) interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

## Parameters

table
thead
tr
th
strong
Parameter
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
system
td
em
string
td
p
Whether to show system-defined MIME types.
p
span
This parameter defaults to 
code
yes
span
.
td
ul
li
code
yes
 — Show all MIME types.
li
code
no
 — Show only user-defined MIME types.
td
code
no
tr
td
code
user
td
em
string
td
p
Whether to show user-defined MIME types.
p
span
This parameter defaults to 
code
yes
span
.
td
ul
li
code
yes
 — Show all MIME types.
li
code
no
 — Show only system-defined MIME types.
td
code
no
## Returns

table
thead
tr
th
strong
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
extension
td
em
string
td
The file extension.
td
A valid 
a
file extension
.
td
code
.txt
tr
td
code
handler
td
em
string
td
The name of the handler.
td
A valid Apache handler type, which contains a hyphen.
td
code
plain-text
tr
td
code
origin
td
em
string
td
Whether the handler is user-defined or system-defined.
td
ul
li
code
user
li
code
system
td
code
user
tr
td
code
ext
td
em
string
td
The file extension.
td
A valid 
a
file extension
.
td
code
.txt
tr
td
code
reason
td
em
string
td
div
p
A reason for failure.
p
This function only returns a 
code
reason
 value if it failed.
td
p
A string that describes the error.
td
code
This is an error message.
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1