v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

ClamScanner

Antivirus Protection (ClamAV)

Return infected file list

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

Note:

You must run the APIs in this order:

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

get/ClamScanner/list_infected_files

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "list_infected_files",
  "module": "ClamScanner",
  "result": {
    "data": [
      {
        "file": "/home/username/infected_file.txt",
        "virus_type": "Eicar-Signature"
      }
    ],
    "status": 1
  }
}