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

Description

This function adds a MIME type to Apache.

Important:

In cPanel & WHM version 76 and later, when you disable the WebServer role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Mime/add_mime?type=text%2Ffoo&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.
 
// Add MIME type of text/foo to .foo
$mime_add_mime = $cpanel->uapi(
    'Mime', 'add_mime',
    array(
        'type'       => 'text/foo',
        '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.
 
# Add MIME type of text/foo to .foo
my $mime_add_mime = $cpliveapi->uapi(
    'Mime', 'add_mime',
    {
        'type'       => 'text/foo',
        'extension'  => '.foo',
    }
);


Note:

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

 cPanel Template Toolkit
<!--  Add MIME type of text/foo to .foo -->
[% data = execute( 'Mime', 'add_mime', {'type' => 'text/foo','extension' => '.foo'} ); %]


Note:

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

 Command Line
uapi --user=username Mime add_mime type=text%2Ffoo 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. 
  • 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": null
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
typestring

Required

The MIME type.

A valid MIME type.

text/foo
extensionstring

Required

The file extension.

A valid file extension.
.foo

Returns

This function only returns metadata.