Developer Documentation
Child pages
  • WHM API 1 Functions - php_set_handler
Skip to end of metadata
Go to start of metadata

Guide to WHM API 1

Return Data

Filter Output

Sort Output

Paginate Output

Output Columns

Call cPanel API 2 and UAPI

 

 

Description

This function sets a PHP version's handler.

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 

 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/php_set_handler?api.version=1&version=ea-php70&handler=suphp
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/php_set_handler?api.version=1&version=ea-php70&handler=suphp
 Command Line
whmapi1 php_set_handler version=ea-php70 handler=suphp


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.

  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
   "data":{
   },
   "metadata":{
      "version":1,
      "reason":"OK",
      "result":"1",
      "command":"php_set_handler"
   }
}
 Output (XML)
<result>
    <data/>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>php_set_handler</command>
    </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample

version

string

Required

An installed PHP version.

  • ea-php54
  • ea-php55
  • ea-php56
  • ea-php70
  • ea-php71
  • ea-php72
  • Any custom PHP package name.
ea-php70
handlerstring

Required

An installed PHP handler.

  • cgi
  • suphp
  • dso
  • none
suphp

Returns

This function returns only metadata.

Function information

API Version:

WHM API 1

Available in:

WHM 54+

Methods:

GET, POST

Required Parameters:

version, handler

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

Notes:

  • Some functions and parameters may require that you authenticate as the root user.
  • You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.

Find a function

Related functions