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.

SecurityBasicAuth
Request
query Parameters
domain
string <domain>

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.
Example: domain=example.com
system_default
integer

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.

Enum: 1 0
Example: system_default=1
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_impacted_domains
Request samples
uapi --output=jsonpretty \
  --user=username \
  LangPHP \
  php_get_impacted_domains
Response samples
application/json
{
  • "apiversion": 3,
  • "func": "php_get_impacted_domains",
  • "module": "LangPHP",
  • "result": {
    • "data": {
      • "domains": [
        • "example.com"
        ]
      },
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}