cPanel API 2 Functions - Mime::listhandlers

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

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.

Important:

When you disable the Web Server role, the system disables this function.

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

Note:

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 handlers associated with Apache
$list_handlers = $cpanel->api2(
    'Mime', 'listhandlers',
    array(
        'system'     => 'no',
  )
);

Note:

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 Apache's handlers
my $list_handlers = $cpliveapi->api2(
    'Mime', 'listhandlers',
    {
        'system'     => 'no',
 }
);

Note:

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

cPanel Tag System (deprecated)

Warnings:

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 listhandlers system=no

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 documentation or run the cpapi2 --help command.
If you run CloudLinux™, you must use the full path of the cpapi2 command:
```
/usr/local/cpanel/bin/cpapi2
```

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 (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter Type Description Possible values Example

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

system

string

Whether to show system-defined MIME types.

This parameter defaults to yes .

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

no

user

string

Whether to show user-defined MIME types.

This parameter defaults to yes .

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. This function only returns a `reason` 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`