UAPI SSL::is_autossl_check_in_progress

[rinkleton]

UAPI Functions - SSL::is_autossl_check_in_progress - Developer Documentation - cPanel Documentation

The docs say it will return 'status' as 0 or 1 for if the check is in progress. It looks like status is always being returned as 1. My guess is because status is usually used by UAPI to let us know if the command executed successfully.

Can anyone confirm this?

 

[cPanelMichael]

Hello @rinkleton,

You are correct. The "status" output from this UAPI function will always return "1" if the UAPI function executes successfully. The information you are looking for with this function is found with the "data" result. For example, when autossl_check is running for the user, it will show "data: 1" instead of "data: 0" :

# uapi --user=user123 SSL is_autossl_check_in_progress
---
apiversion: 3
func: is_autossl_check_in_progress
module: SSL
result:
  data: 1
  errors: ~
  messages: ~
  metadata: {} 
  status: 1
  warnings: ~

I've opened a case with our Documentation Team (DOC-10939) to ensure this document is updated to reflect this information. I'll update this thread once the changes are published.

Thank you.

 

[cPanelMichael]

Hello @rinkleton,

The document is now updated to reflect the noted change.

Thanks!