UAPI Functions - Mime::delete_handler - Knowledgebase

Description

This function deletes an Apache MIME type handler.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Mime/delete_handler?extension=.foo

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Delete handler from ".foo"
$mime_delete_handler = $cpanel->uapi(
    'Mime', 'delete_handler',
    array(
        'extension'    => '.foo',
 )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Delete handler from ".foo"
my $mime_delete_handler = $cpliveapi->uapi(
    'Mime', 'delete_handler',
    {
        'extension'    => '.foo',
    }
);

cPanel Template Toolkit

[% data = execute( 'Mime', 'delete_handler', {'extension'=> '.foo'} ); %]

Command Line

uapi --user=username Mime delete_handler extension=.foo

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
  "messages": [
    "Htaccess Installed"
  ],
  "errors": null,
  "status": 1,
  "data": null
}

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
extension	string	Required The file extension.	A valid file extension.	.foo

Parameter

Type

Description

Possible values

Example

extension

string

Required

The file extension.

A valid file extension.

.foo

Returns

This function only returns metadata.

Knowledgebase

Categories

Categories