Child pages
  • UAPI Functions - SSL::set_primary_ssl
Skip to end of metadata
Go to start of metadata

Description

This function sets a new primary SSL website for a dedicated IP address.

Important:

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

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/SSL/set_primary_ssl?servername=hostname.example.com


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Set the primary SSL website for the dedicated IP address to "hostname.example.com"
$SSL_set_primary_ssl = $cpanel->uapi(
    'SSL', 'set_primary_ssl',    array(
        'servername'      => 'hostname.example.com',
    )
);


Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Set the primary SSL website for the dedicated IP address to "hostname.example.com"
my $SSL_set_primary_ssl = $cpliveapi->uapi(
    'SSL', 'set_primary_ssl',    {
        'servername'     => 'hostname.example.com',
    }
);


Note:

For more information, read our Guide to the LiveAPI System.

 Command Line
uapi --user=username SSL set_primary_ssl servername=hostname.example.com


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": null
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
servernamestring

Required

The primary SSL website's servername.

A valid hostname.
hostname.example.com

Returns

This function only returns metadata.