Return Security Advisor results

This function returns the cPanel Security Advisor's security scan data. It advises you of how to resolve any security issues that it finds.

Note:

For more information, read the cPanel Security Advisor documentation at the cPanel, L.L.C. GitHub® repository.

Authorizations:

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  fetch_security_advice

Response samples

Content type
application/json
{
  • "data": {
    • "payload": [
      • {
        • "advice": {
          • "key": "SSH_direct_root_login_permitted",
          • "suggestion": "Manually edit /etc/ssh/sshd_config and change PermitRootLogin to “without-password” or “no”, then restart SSH …",
          • "summary": "SSH direct root logins are permitted.",
          • "type": "ADVISE_BAD"
          },
        • "module": "Cpanel::Security::Advisor::Assessors::SSH",
        • "type": "mod_advice"
        },
      • {
        • "advice": {
          • "key": "SSH_is_current",
          • "suggestion": null,
          • "summary": "Current SSH version is up to date: 11.22p33-44",
          • "type": "ADVISE_GOOD"
          },
        • "module": "Cpanel::Security::Advisor::Assessors::SSH",
        • "type": "mod_advice"
        },
      • {
        • "message": "Anvil not found at /usr/local/cpanel/Cpanel/Security/Advisor/Assessors/ACME.pm line 6.",
        • "module": "Cpanel::Security::Advisor::Assessors::ACME",
        • "type": "mod_load"
        }
      ]
    },
  • "metadata": {
    • "command": "fetch_security_advice",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}