Child pages
  • cPanel API 2 Functions - Mime::listhandlers

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

This function lists Apache's handlers.


Warning
titleWarning:

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

  • Mime::list_handlers

    Excerpt Include
    DD:UAPI Functions - Mime::list_handlersDD:
    UAPI Functions - Mime::list_handlers
    nopaneltrue

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledWebServerRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleWHM API (JSON)


Code Block
languagetext
https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Mime&cpanel_jsonapi_func=listhandlers&system=no

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List handlers associated with Apache
$list_handlers = $cpanel->api2(
    'Mime', 'listhandlers', 
    array(
        'system'     => 'no',
  ) 
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# List Apache's handlers
my $list_handlers = $cpliveapi->api2(
    'Mime', 'listhandlers',
    { 
        'system'     => 'no',
 }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning


Expand
titleCommand Line


Code Block
languagebash
cpapi2 --user=username Mime listhandlers system=no

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
 "cpanelresult": {
    "apiversion": 2,
    "func": "listhandlers",
    "data": [
      {
        "extension": ".txt",
        "handler": "plain-text",
        "origin": "user",
        "ext": ".txt"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Mime"
  }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


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

Return TypeDescriptionPossible valuesExample
extensionstringThe file extension.A valid file extension..txt
handlerstringThe name of the handler.A valid Apache handler type, which contains a hyphen.plain-text
originstringWhether the handler is user-defined or system-defined.
  • user
  • system
user
extstringThe file extension.A valid file extension..txt
reasonstring

A reason for failure.

Note
titleNote:

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