Sign in

v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
ClamScanner
Antivirus Protection (ClamAV)

Start virus scan

This function starts a ClamAV® scan on a directory.

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.
get/ClamScanner/start_scan

Query parameters

scan_type'home' | 'mail' | 'public_html' | 'public_ftp' required
Example:home

The type of directory to scan.

  • home — User's entire home directory
  • mail — User's email directory
  • public_html — User's web directory
  • public_ftp — User's ftp directory

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": "start_scan",
  "module": "ClamScanner",
  "result": {
    "status": 1
  }
}