Skip to content
cPanel API 2 Modules
/
cPanel API 2 Modules - Mime
/
cPanel API 2 Functions - Mime::listmime
Last updated

cPanel API 2 Functions - Mime::listmime

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 MIME types.

Warning:

We strongly recommend that you use the following UAPI function instead of this function:

— This function lists all of Apache's MIME types.

Note:

When the user or domain enables PHP-FPM, the system displays only the custom MIME types that you or third parties added.

Important:

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

Examples

WHM API (JSON)

syntaxhighlighter-pre
https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Mime&cpanel_jsonapi_func=listmime&system=no
Note:

For more information, read our Calls from the WHM API documentation.

LiveAPI PHP Class

syntaxhighlighter-pre
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// List mime types associated with Apache
$list_mime = $cpanel->api2(
    'Mime', 'listmime',
    array(
        'system'     => 'no',
  )
);
Note:

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

LiveAPI Perl Module

syntaxhighlighter-pre
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# List mime types associated with Apache
my $list_mime = $cpliveapi->api2(
    'Mime', 'listmime',
    {
        '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

syntaxhighlighter-pre
cpapi2 --user=username Mime listmime 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:

    syntaxhighlighter-pre
    /usr/local/cpanel/bin/cpapi2

Output (JSON)

syntaxhighlighter-pre
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listmime",
    "data": [
      {
        "extension": ".hat",
        "origin": "user",
        "type": "hat/silly",
        "ext": ".hat"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Mime"
  }
}
Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
systemstring

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
userstring

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

ReturnTypeDescriptionPossible valuesExample
extensionstringThe file extension.

A valid file extension.

.txt
originstringWhether the MIME type is user-defined or system-defined.
  • system — System-defined MIME type.
  • user — User-defined MIME type.
system
typestringThe MIME type.A valid MIME type.text/plain
extstringThe file extension.A valid file extension..txt
reasonstring

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.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1
Previous page
Next page