You can find our user documentation at docs.cpanel.net.

Check out our new API beta site!

Child pages
  • UAPI Functions - Mime::list_handlers
Skip to end of metadata
Go to start of metadata

Description

This function lists all of Apache's MIME handlers.

Important:

In cPanel & WHM version 76 and later, when you disable the Web Server role, the system disables this function.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Mime/list_handlers?type=user


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List all of Apache user handlers
$mime_list_handlers = $cpanel->uapi(
    'Mime', 'list_handlers',
    array(
        'type'    => 'user',
    )
);


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 all of Apache user handlers
my $mime_list_handlers = $cpliveapi->uapi(
    'Mime', 'list_handlers',
    {
        'type'    => 'user',
    }
);


Note:

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

 Command Line
uapi --user=username Mime list_handlers type=user


Notes:

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

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": [
    {
      "extension": "foo",
      "handler": "text-foo",
      "origin": "user"
    }
  ],
  "metadata": {
    "transformed": 1
  }
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
typestring

Required

Whether to retrieve system or user handlers.

  • system
  • user
user

Returns

ReturnTypeDescriptionPossible valuesExample
originstringThe handler's owner.
  • system
  • user
user

handler

stringThe handler's name.A valid string.
text-foo
extensionstringThe handler's extension.A valid file extension..foo