Page tree
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.

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.

 cPanel Template Toolkit
<!-- Verify whether the autossl_check task is in progress for the current user. -->
[% execute( 'SSL', 'is_autossl_check_in_progress' ); %]

Note:

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

 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. 
  • We introduced this functionality in cPanel & WHM version 56.

 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

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

 

 

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