# 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.



  For more information, read the cPanel Security Advisor documentation at the WebPros International, LLC GitHub® repository.

Endpoint: GET /fetch_security_advice
Version: 11.134.0.5
Security: BasicAuth

## Response 200 fields (application/json):

  - `data` (object)

  - `data.payload` (array)
    * This function only returns the the  array of objects when the  return is the  value.
 * This function only returns the  return when the  return is the  or  value.

  - `data.payload.advice` (object)
    This function only returns this object when the  return is the  value.

  - `data.payload.advice.key` (string)
    A unique check identifier in the module that returns a status message.
    Example: "ClamAV_not_installed"

  - `data.payload.advice.suggestion` (string,null)
    A message that suggests how to resolve the security issue.
    Example: "Install ClamAV within \"<a target=\\\"_blank\\\" href=\\\"https://example.com:2087/scripts2/manage_plugins\\\">Manage Plugins</a>\"."

  - `data.payload.advice.summary` (string)
    A summary about the module's current security status.
    Example: "ClamAV is not installed."

  - `data.payload.advice.type` (string)
    The level at which the module returns a specific security message.
*  - The object contains a security issue.
*  - There are no security issues.
*  - The object contains an informational message.
*  - The object contains a warning.
    Enum: "ADVISE_BAD", "ADVISE_GOOD", "ADVISE_INFO", "ADVISE_WARN"

  - `data.payload.message` (string)
    A message that describes an error.



  This function only returns this value for the  return's  and  values.
    Example: "Can't call method \"get_raw_conf\" on an undefined value at /usr/local/cpanel/Whostmgr/Services/SSH/Config.pm line 160."

  - `data.payload.module` (string)
    The name of a module that the Security Advisor checked.
    Example: "Cpanel::Security::Advisor::Assessors::ClamAV"

  - `data.payload.type` (string)
    The type of security message.

*  - There is a message from the Security Advisor module.
*  - There was an error preventing the loading of the module.
*  - There was an error preventing the system from completing one of the module's checks.
    Enum: "mod_advice", "mod_load", "mod_run"

  - `metadata` (object)

  - `metadata.command` (string)
    The method name called.
    Example: "fetch_security_advice"

  - `metadata.reason` (string)
    The reason the API function failed when the  field is . This field may display a success message when a function succeeds.
    Example: "OK"

  - `metadata.result` (integer)
    *  - Success
*  - Failed: Check the reason field for more details.
    Enum: 0, 1

  - `metadata.version` (integer)
    The version of the API function.
    Example: 1