---
title: "Return Security Advisor results"
method: GET
path: "/fetch_security_advice"
tags: ["Security"]
---

# Return Security Advisor results

`GET /fetch_security_advice`

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](https://go.cpanel.net/githubsecurityadvisor) documentation at the WebPros International, LLC GitHub® repository.

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `payload` object[] — **Note:** * This function only returns the the `advice` array of objects when the `type` return is the `mod_advice` value. * This function only returns the `message` return when the `type` return is the `mod_load` or `mod_run` value.
      - `advice` object — **Note:** This function only returns this object when the `type` return is the `mod_advice` value.
        - `key` string — A unique check identifier in the module that returns a status message.
        - `suggestion` string, HTML, nullable — A message that suggests how to resolve the security issue.
        - `summary` string, HTML — A summary about the module's current security status.
        - `type` 'ADVISE_BAD' | 'ADVISE_GOOD' | 'ADVISE_INFO' | 'ADVISE_WARN' — The level at which the module returns a specific security message. * `ADVISE_BAD` - The object contains a security issue. * `ADVISE_GOOD` - There are no security issues. * `ADVISE_INFO` - The object contains an informational message. * `ADVISE_WARN` - The object contains a warning.
      - `message` string — A message that describes an error. **Note:** This function only returns this value for the `type` return's `mod_load` and `mod_run` values.
      - `module` string — The name of a module that the Security Advisor checked.
      - `type` 'mod_advice' | 'mod_load' | 'mod_run' — The type of security message. * `mod_advice` - There is a message from the Security Advisor module. * `mod_load` - There was an error preventing the loading of the module. * `mod_run` - There was an error preventing the system from completing one of the module's checks.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` - Success * `0` - Failed: Check the reason field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)