v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
LangPHP
PHP Settings

Return domains that shared PHP configuration

This function lists domains that obtain their PHP version from a specified PHP configuration.

Note:

This document only applies to systems that run EasyApache 4.

Important:

When you disable the WebServer role, the system disables this function.

get/LangPHP/php_get_impacted_domains

Query parameters

domainstring domain
Example:example.com

A domain on the system.

Note:

  • You must pass either the system_default or domain parameters, or both.
  • You can pass this parameter multiple times.
  • You cannot pass the name of a parked domain.
system_default1 | 0
Example:1

Whether to return domains that inherit the system's default PHP version.

  • 1 - Return domains that inherit the system's default PHP version.
  • 0 - Do not return domains that inherit the system's default PHP version.

Note:

If you pass this parameter with a false value and do not also pass the domain parameter, the function returns an error.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "php_get_impacted_domains",
  "module": "LangPHP",
  "result": {
    "data": {
      "domains": [
        "example.com"
      ]
    },
    "status": 1
  }
}