Child pages
  • WHM API 1 Functions - php_get_impacted_domains

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

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

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledWebServerRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleJSON API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/php_get_impacted_domains?api.version=1&system_default=1&domain=example.com



Expand
titleXML API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/php_get_impacted_domains?api.version=1&system_default=1&domain=example.com



Expand
titleCommand Line


Code Block
languagebash
whmapi1 php_get_impacted_domains system_default=1 domain=example.com

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


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



Expand
titleOutput (XML)


Code Block
languagetext
linenumberstrue
<result>
    <metadata>
        <result>1</result>
        <command>php_get_impacted_domains</command>
        <reason>OK</reason>
        <version>1</version>
    </metadata>
    <data>
        <domains>example.com</domains>
        <domains>subdomain.example.com</domains>
        <domains>example2.com</domains>
    </data>
</result>


Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
system_defaultBoolean

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

Note
titleNotes:
  • We introduced this parameter in cPanel & WHM version 64.
  • You must pass either the system_default or domain parameters, or both.  


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

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


1
domainstring

A domain on the system.

Note
titleNote:
  • We introduced this parameter in cPanel & WHM version 64.
  • You must pass either the system_default or domain parameters, or both.  
  • You can pass this parameter multiple times.


Any valid domain name on the system.

Note
titleNote:

You cannot pass the name of a parked domain.


example.com

location

string

The location of a PHP configuration.

Note
titleNote:

We removed this parameter in cPanel & WHM version 64.


    • system:default
    • domain:example.com
domain:example.com

Returns

ReturnTypeDescriptionPossible valuesExample

domains

array

The domains that obtain their PHP version from the PHP configuration.

Any valid domain or subdomain.

Note
titleNote:

This function does not return parked domains.


example.com