Return PHP version's handler

This function returns a PHP version's assigned PHP handler.

Note:

This document only applies to systems that run EasyApache 4.

Important:

When you disable the WebServer role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

SecurityBasicAuth
Request
query Parameters
type
required
string

The type of php.ini file.

  • home
  • vhost

Important:

  • If you set this parameter to vhost, you must also include the vhost parameter.
  • If you set this parameter to home, the system returns the system default PHP handler.
Enum: "home" "vhost"
Example: type=vhost
vhost
string <domain>

The name of a virtual host.

Important:

If the type value is vhost, you must use this parameter.

Example: vhost=clearly.com
Responses
200

HTTP Request was successful.

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object
get/LangPHP/php_get_domain_handler
Request samples
uapi --output=jsonpretty \
  --user=username \
  LangPHP \
  php_get_domain_handler \
  type='vhost'
Response samples
application/json
{
  • "apiversion": 3,
  • "func": "php_get_domain_handler",
  • "module": "LangPHP",
  • "result": {
    • "data": {
      • "php_handler": "cgi"
      },
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}