latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

PHP

Return PHP preconfigured domains

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

Important:

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

get/php_get_impacted_domains

Query parameters

domainstring required

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 required
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:

  • You must pass either the system_default or domain parameters, or both.
  • 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.

Example response

{
  "data": {
    "domains": [
      "example.com",
      "subdomain.example.com",
      "example2.com"
    ]
  },
  "metadata": {
    "command": "php_get_impacted_domains",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}