Return infected file list

This function lists infected files from a ClamAV® virus scan.

Note:

You must run the APIs in this order:

  1. Run ClamScanner::start_scan to start the virus scan.
  2. Run ClamScanner::get_scan_status in a loop until the scan is finished.
  3. Run ClamScanner::list_infected_files to get a report of the complete list of infected files.
  4. Decide how you want to handle each infected file.
  5. Run ClamScanner::disinfect_files to queue the disinfection of the files.
  6. Run ClamScanner::check_disinfection_status in a loop until you get a done status.
SecurityBasicAuth
Responses
200

HTTP Request was successful.

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object
get/ClamScanner/list_infected_files
Request samples
uapi --output=jsonpretty \
  --user=username \
  ClamScanner \
  list_infected_files
Response samples
application/json
{
  • "apiversion": 3,
  • "func": "list_infected_files",
  • "module": "ClamScanner",
  • "result": {
    • "data": [
      • {
        • "file": "/home/username/infected_file.txt",
        • "virus_type": "Eicar-Signature"
        }
      ],
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}