---
title: "Request virus scan status"
method: GET
path: "/ClamScanner/get_scan_status"
tags: ["ClamScanner", "Antivirus Protection (ClamAV)"]
---

# Request virus scan status

`GET /ClamScanner/get_scan_status`

This function gets the status of a ClamAV® scan on a directory.

**Note**:

You must run the APIs in this order:

1. Run [`ClamScanner::start_scan`](https://go.cpanel.net/ClamScanner-start-scan) to start the virus scan.
2. Run [`ClamScanner::get_scan_status`](https://go.cpanel.net/ClamScanner-get-scan-status) in a loop until the scan is finished.
3. Run [`ClamScanner::list_infected_files`](https://go.cpanel.net/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`](https://go.cpanel.net/ClamScanner-disinfect-files) to queue the disinfection of the files.
6. Run [`ClamScanner::check_disinfection_status`](https://go.cpanel.net/ClamScanner-check-disinfection-status) in a loop until you get a done status.

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer — The version of the API.
  - `func` string — The name of the method called.
  - `module` string — The name of the module called.
  - `result` object
    - `data` object
      - `current_file` string — The current file being scanned.
      - `infected_files` string[] — List of files scanned and found to be infected.
      - `scan_complete` 0 | 1 — Whether the last scan has completed. * `1` - scan has completed. * `0` - scan has **not** completed.
      - `scanned_file_count` integer — The number of files already scanned.
      - `scanned_file_size` integer — The number of bytes of data scanned.
      - `time_started` string — The epoch timestamp of the beginning of the last scan.
      - `total_file_count` integer — The total number of files found to scan.
      - `total_file_size_MiB` integer — The total number of megabytes of data found to scan.
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
    - `status` 0 | 1 — * `1` - Success. * `0` - Failed. Check the `errors` field for more details.
    - `warnings` string[], nullable — List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.

---

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