Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function removes SSL from a domain.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/SSL/delete_ssl?domain=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.
 
// Remove SSL from example.com.
$SSL_delete_ssl = $cpanel->uapi(
    'SSL', 'delete_ssl',    array(
        'domain'    => '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.
 
#  Remove SSL from example.com.
my $SSL_delete_ssl = $cpliveapi->uapi(
    'SSL', 'delete_ssl',    {
        'domain'    => 'example.com',
    }
);

Note:

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

 cPanel Template Toolkit
<!-- Remove SSL from example.com. -->
[% data = execute( 'SSL', 'delete_ssl', { domain => 'example.com'} ); %]
[% FOREACH q = data %]
     <p>
         [% q %]
     </p>
[% END %]

Note:

For more information, read our Guide to Template Toolkit documentation. 

 Command Line
uapi --user=username SSL delete_ssl domain=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. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{
  "messages": [
    "The SSL host was successfully removed."
  ],
  "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
domainstring

Required

The domain name.

A valid domain name.
example.com

Returns

ReturnTypeDescriptionPossible valuesExample
messagesstringA confirmation message.The SSL host was successfully removed. is the only possible value.
The SSL host was successfully removed.