- Created by Documentation, last modified on Oct 05, 2018
disable_authentication_provider
disable_failing_authentication_providers
enable_authentication_provider
get_available_authentication_providers
get_provider_client_configurations
get_provider_configuration_fields
get_provider_display_configurations
get_users_authn_linked_accounts
set_provider_client_configurations
set_provider_display_configurations
twofactorauth_generate_tfa_config
twofactorauth_get_user_configs
cpgreylist_is_server_netblock_trusted
cpgreylist_list_entries_for_common_mail_provider
cpgreylist_load_common_mail_providers_config
cpgreylist_save_common_mail_providers_config
cpgreylist_trust_entries_for_common_mail_provider
cpgreylist_untrust_entries_for_common_mail_provider
create_cpgreylist_trusted_host
delete_cpgreylist_trusted_host
Description
This function lists the virtual hosts that use a specified version of PHP.
Note:
This document only applies to systems that run EasyApache 4.
Important:
WebServer
role, the system disables this function. For more information, read our How to Use Server Profiles documentation.Examples
https://hostname.example.com:2087/cpsess##########/json-api/php_get_vhosts_by_version?api.version=1&version=ea-php56
https://hostname.example.com:2087/cpsess##########/xml-api/php_get_vhosts_by_version?api.version=1&version=ea-php56
whmapi1 php_get_vhosts_by_version version=ea-php56
Notes:
- You must URI-encode values.
- For more information and additional output options, read our Guide to WHM API 1 documentation or run the
whmapi1 --help
command. If you run CloudLinux™, you must use the full path of the
whmapi1
command:/usr/local/cpanel/bin/whmapi1
{ "metadata":{ "reason":"OK", "version":1, "result":1, "command":"php_get_vhosts_by_version" }, "data":{ "vhosts":[ "example.com", "new.example.com", "example1.com", "example2.com" ] } }
<result> <metadata> <result>1</result> <version>1</version> <reason>OK</reason> <command>php_get_vhosts_by_version</command> </metadata> <data> <vhosts>new.example.com</vhosts> <vhosts>example.com</vhosts> <vhosts>example1.com</vhosts> <vhosts>example2.com</vhosts> </data> </result>
Note:
Parameters
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
version | string | Required The name of an installed PHP package. |
| ea-php56 |
Returns
Return | Type | Description | Possible values | Example |
---|---|---|---|---|
| array | An array of the virtual hosts that use the specified PHP version. | Any valid virtual host name. | example.com |
Function information
API Version:
Available in:
WHM 62+
Methods:
GET, POST
Required Parameters:
version
Return Formats:
About WHM API 1
WHM API 1 performs functions and accesses data in WHM.Notes:
- Some functions and parameters may require that you authenticate as the
root
user. - You must use the appropriate WHM ports (
2086
or2087
) to call WHM API functions.
Find a function
Related functions
-
Page:WHM API 1 Sections - PHP — PHP functions allow you to manage your system's PHP configuration.
-
Page:WHM API 1 Functions - php_get_handlers — This function returns the PHP handlers on the system.
-
Page:WHM API 1 Functions - php_get_impacted_domains — This function lists domains that obtain their PHP version from a specified PHP configuration.
-
Page:WHM API 1 Functions - php_get_installed_versions — This function returns the installed PHP versions on a server.
-
Page:WHM API 1 Functions - php_get_system_default_version — This function returns the system default PHP version.