You can find our user documentation at docs.cpanel.net.

Check out our new API beta site!

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

Description

This function initiates an AutoSSL check for the user.

Important:

In cPanel & WHM version 84 and later, when you disable the Calendars and Contacts, Receive MailWeb DiskWebmail, and Web Server roles, the system disables this function.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/SSL/start_autossl_check


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.
 
// Initiate an AutoSSL check for the user.
$SSL_start_autossl_check = $cpanel->uapi(
    'SSL', 'start_autossl_check'
);


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.
 
#  Initiate an AutoSSL check for the user.
my $SSL_start_autossl_check = $cpliveapi->uapi(
    'SSL', 'start_autossl_check'
);


Note:

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

 Command Line
uapi --user=username SSL start_autossl_check


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

This function does not accept parameters.

Returns

This function only returns metadata.