We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

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

Description

This function verifies whether the autossl_check task is in progress for the current user.

Important:

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

Examples


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


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.
 
// Verify whether the autossl_check task is in progress for the current user.
$SSL_is_autossl_check_in_progress = $cpanel->uapi(
    'SSL', 'is_autossl_check_in_progress'
);


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.
 
# Verify whether the autossl_check task is in progress for the current user.
my $SSL_is_autossl_check_in_progress = $cpliveapi->uapi(
    'SSL', 'is_autossl_check_in_progress'
);


Note:

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

 Command Line
uapi --user=username SSL is_autossl_check_in_progress


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": 1
}


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

ReturnTypeDescriptionPossible valuesExample
dataBoolean
Whether the autossl_check task is in progress for the current user.



  • 1 — In progress.
  • 0Not currently in progress.
1