---
title: "Launch a scan"
method: POST
path: "/scans/{scanId}/launch"
tags: ["Scans"]
---

# Launch a scan

`POST /scans/{scanId}/launch`

You will need at least one file to be present before launching a scan.
If the scan has already been launched, you will received a 200 response.

## Path parameters

- `scanId` string, required

## Request body

- ScanOption
  - `force` boolean
  - `probes` string
  - `mimetype_filtering` boolean
  - `resubmit_files` boolean

## Response `200`

OK

- Scan
  - `id` string
  - `force` boolean
  - `resubmit_files` boolean
  - `mimetype_filtering` boolean
  - `date` string, date-time
  - `status` integer
  - `probes_total` integer
  - `probes_finished` integer
  - `results` SummaryScanResult[]
    - `status` integer
    - `probes_finished` integer
    - `probes_total` integer
    - `scan_id` string
    - `scan_date` string, date-time
    - `name` string
    - `file_sha256` string
    - `parent_file_sha256` string
    - `path` string
    - `result_id` integer

## Other responses

- `202` — Accepted
- `404` — Not Found
- `default` — Unexpected error

---

[API](https://skmtc.dev/quarkslab/apis/irma-api.md) · [All operations](https://skmtc.dev/quarkslab/apis/irma-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/quarkslab/irma-api/revisions/1e1006c1389c/schema)