Page tree
Skip to end of metadata
Go to start of metadata

 

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

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.
 
// Delete handler from ".foo"
$mime_delete_handler = $cpanel->uapi(
    'Mime', 'delete_handler',
    array(
        'extension'    => '.foo',
 )
);

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.
 
# Delete handler from ".foo"
my $mime_delete_handler = $cpliveapi->uapi(
    'Mime', 'delete_handler',
    {
        'extension'    => '.foo',
    }
);

Note:

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

 cPanel Template Toolkit
<!-- Delete handler from ".foo" -->
[% data = execute( 'Mime', 'delete_handler', {'extension'=> '.foo'} ); %]

Note:

For more information, read our Guide to Template Toolkit documentation. 

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

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. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{
  "messages": [
    "Htaccess Installed"
  ],
  "errors": null,
  "status": 1,
  "data": null
}

Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
extensionstring

Required

The file extension.

A valid file extension..foo

Returns

This function only returns metadata.