WHM API 1 Functions - set_primary_servername

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:

In cPanel & WHM version 76 and later, when you disable the WebServer role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples

JSON API

https://hostname.example.com:2087/cpsess##########/json-api/set_primary_servername?api.version=1&servername=hostname.example.com&type=std

XML API

https://hostname.example.com:2087/cpsess##########/xml-api/set_primary_servername?api.version=1&servername=hostname.example.com&type=std

Command Line

whmapi1 set_primary_servername servername=hostname.example.com type=std

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
```

Output (JSON)

{
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": 1,
        "command": "set_primary_servername"
    }
}

Output (XML)

<result>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>set_primary_servername</command>
    </metadata>
</result>

Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

Parameter Type Description Possible values Example

servername

string

Required

The ServerName value in Apache's VirtualHost section to set as primary for the IP address and port type.

A valid hostname.

hostname.example.com

type

string

The type of virtual host to set as primary.

This value defaults to std.

std — Port 80
ssl — Port 443

std

Returns

This function only returns metadata.

Function information

API Version:

WHM API 1

Available in:

WHM 11+

Methods:

GET, POST

Required Parameters:

servername

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

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 or 2087) 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.

Child pages