UAPI Functions - SSL::delete_ssl - Knowledgebase

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

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',

)

);

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',

}

);

cPanel Template Toolkit

[% data = execute( 'SSL', 'delete_ssl', { domain => 'example.com'} ); %]

[% FOREACH q = data %]

<p>

[% q %]

</p>

[% END %]

Command Line

uapi --user=username SSL delete_ssl domain=example.com

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
  "messages": [
    "The SSL host was successfully removed."
  ],
  "errors": null,
  "status": 1,
  "data": null
}

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
domain	string	Required The domain name.	A valid domain name.	example.com

Parameter

Type

Description

Possible values

Example

domain

string

Required

The domain name.

A valid domain name.

example.com

Returns

Return	Type	Description	Possible values	Example
messages	string	A confirmation message.	The SSL host was successfully removed.is the only possible value.	The SSL host was successfully removed.

Knowledgebase

Categories

Categories