- 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
block_incoming_email_from_country
block_incoming_email_from_domain
expunge_messages_for_mailbox_guid
get_unique_recipient_count_per_sender_for_user
get_unique_sender_recipient_count_per_user
get_user_email_forward_destination
list_blocked_incoming_email_countries
list_blocked_incoming_email_domains
set_user_email_forward_destination
unblock_incoming_email_from_country
unblock_incoming_email_from_domain
Description
This function sets the primary domain on an IP address and port for an account's sites. The primary domain refers to the virtual host that the server returns when a visitor directly accesses the IP address.
For example, if both example1.com
and example2.com
are name-based virtual hosts on IP address 192.168.0.1
, the primary virtual host appears when the visitor accesses the http://192.168.0.1/
location.
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/set_primary_servername?api.version=1&servername=hostname.example.com&type=std
https://hostname.example.com:2087/cpsess##########/xml-api/set_primary_servername?api.version=1&servername=hostname.example.com&type=std
whmapi1 set_primary_servername servername=hostname.example.com type=std
Notes:
- Unless otherwise noted, 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": { "version": 1, "reason": "OK", "result": 1, "command": "set_primary_servername" } }
<result> <metadata> <version>1</version> <reason>OK</reason> <result>1</result> <command>set_primary_servername</command> </metadata> </result>
Note:
Parameters
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
servername | string | Required The | A valid hostname.
| hostname.example.com |
type | string | The type of virtual host to set as primary. This value defaults to |
| std |
Returns
This function only returns metadata.
Function information
API Version:
Available in:
WHM 11+
Methods:
GET, POST
Required Parameters:
servername
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 Functions - get_tweaksetting — This function retrieves a value from the
/var/cpanel/cpanel.config
file. -
Page:WHM API 1 Functions - getdiskusage — This function retrieves the server's drive partition information.
-
Page:WHM API 1 Functions - systemloadavg — This function retrieves the system's load average.
-
Page:WHM API 1 Functions - loadavg — This function retrieves the server's load average.
-
Page:WHM API 1 Functions - gethostname — This function retrieves the server's hostname.