v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

ClamScanner

Antivirus Protection (ClamAV)

Request disinfection process status

This function checks the status of the previously queued disinfection of infected files.

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.

If you want to display the progress, you can render the ClamScanner::check_disinfection_status returned 'result{data}{details}' array where the type is step.

Each step record indicates the action taken on a specific file in the set being processed.

get/ClamScanner/check_disinfection_status

Query parameters

last_idinteger

Example:10

The unique id of the message you last received from this same log.

The API will return only the records after the specified last_id.

If this parameter is not provided, the entire log is returned.

Note:

For improved performance, we recommend applications include the last record ID (last_id) from a previous call to this API, so only messages since the previous API call are returned.

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": "check_disinfection_status",
  "module": "ClamScanner",
  "result": {
    "data": {
      "details": [
        {
          "file": "/home/user/virus",
          "id": 2,
          "state": "deleted"
        }
      ],
      "log": "/home/user/.clamavconnector.disinfection.log",
      "status": "done"
    },
    "status": 1
  }
}