---
title: "Start Pre-flight Scan"
method: POST
path: "/targets/{id}/pre-scan-configuration/"
tags: ["Preflight"]
---

# Start Pre-flight Scan

`POST /targets/{id}/pre-scan-configuration/`

Initiates a pre-flight scan for the target.

## Path parameters

- `id` string, required

## Response `202`

- PreScan
  - `status` 'canceled' | 'canceling' | 'completed' | 'completed_with_errors' | 'failed' | 'paused' | 'pausing' | 'queued' | 'resuming' | 'started' | 'under_review' | 'finishing_up' — Status of the scan: * `canceled` - Canceled * `canceling` - Canceling * `completed` - Completed * `completed_with_errors` - Completed with errors - DEPRECATED * `failed` - Failed * `paused` - Paused * `pausing` - Pausing * `queued` - Queued * `resuming` - Resuming * `started` - Started * `under_review` - Under Review * `finishing_up` - Finishing up
  - `started` string, date-time, nullable — Date and time of when the scan started.
  - `completed` string, date-time, nullable — Date and time of when the scan was completed.
  - `duration` string — Total time from the start of the scan to its completion, or to the moment of the query, if not completed. For example, "02 00:00:10.123456".
  - `crawler` Crawler, required
    - `state` string, required — State of the crawler execution. For example, "started" or "ended".
    - `status` integer[], required — List with two numbers where the first is the crawled URLs and the second is the total of URLs to crawl.
    - `warning` CrawlerWarning[], required — List of warnings occurred during the crawler execution.
      - `code` string, required — Warning code.
      - `message` string, required — Warning message.
    - `error` CodedError[], required — List of errors occurred during the crawler execution.
      - `code` string, required
      - `message` string, required
    - `full_status` CrawlerFullStatus
      - `type` string — Type of information. When present, the value is "feedback".
      - `iid` string, uuid, required — Internal information.
      - `aid` string, uuid, required — Internal information.
      - `ts` number, double, required — Timestamp of the crawler execution.
      - `subtype` string, required — Sub-type of the type of information. The value is "status".
      - `stage` string, required — Stage of the scan. The value is "crawler".
      - `module` string, required — Module of the crawler that is executing.
      - `data` CrawlerData, required
        - `type` string — Type of information. When present, the value is "feedback".
        - `countTimeoutEndpoints` integer — Number of requests with timeouts during the crawler execution.
        - `countLoginFailed` integer — Number of failed login attempts during the crawler execution.
        - `version` integer — Version number.
        - `countNetworkErrorEndpoints` integer — Number of network errors during the crawler execution.
        - `doingLogin` boolean — If true, the crawler is currently trying to log in to the target.
        - `done` integer, required — Number of URLs crawled.
        - `rejected` integer — Number of URLs deduplicated during the crawler execution.
        - `total` integer, required — Total number of URLs to crawl.
        - `allExtraHosts` string[] — List of extra hosts.
        - `crawlingEndpoints` LastCrawledEndpoints[] — List of details about endpoints currently being crawled.
          - `jobId` integer — Identifier of the crawler job.
          - `status` integer, required — HTTP response status code for the crawler request.
          - `method` string, required — HTTP method of the crawler request.
          - `url` string, uri, required — URL of the crawler request.
        - `lastLogin` LastLogin[] — List of the last logins.
          - `status` string, required — Status of the login attempt.
          - `timestamp` integer, required — Timestamp of the login attempt.
        - `status` object — Object with all HTTP response codes obtained during the crawler execution and how many of each.
        - `outOfScopeHostsCount` object — List of URLs out of the target's scope and the number of times the crawler hit them.
        - `allHostnames` string[] — List of all hostnames to crawl.
        - `lastCrawledEndpoints` LastCrawledEndpoints[] — List of the last crawled URLs.
          - `jobId` integer — Identifier of the crawler job.
          - `status` integer, required — HTTP response status code for the crawler request.
          - `method` string, required — HTTP method of the crawler request.
          - `url` string, uri, required — URL of the crawler request.
        - `statusByHost` object — List of HTTP response codes obtained during the crawler execution and how many of each, grouped by hostname.
  - `login_video` string, nullable, required
  - `target_response` string, nullable, required

## Other responses

- `400`
- `403`
- `404`
- `409`

---

[API](https://skmtc.net/probely/apis/snyk-api-web-s-api-reference-documentation.md) · [All operations](https://skmtc.net/probely/apis/snyk-api-web-s-api-reference-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/probely/snyk-api-web-s-api-reference-documentation/revisions/e29879bff01b/schema)