---
title: "Create Scan"
method: POST
path: "/v1/scans"
tags: ["scans"]
---

# Create Scan

`POST /v1/scans`

Trigger a scan

## Headers

- `X-Team-Id` string

## Request body

- object
  - `targets` string[]
  - `templates` string[]
  - `assets` string[]
  - `private_templates` PrivateTemplates[]
    - `name` string, required
    - `contents` string, required
  - `name` string
  - `recommended` boolean
  - `all` boolean
  - `alerting_config_ids` string[]
  - `scan_config_ids` string[]
  - `reporting_config_ids` string[]
  - `early_templates` string[]
  - `exclude_targets` string[]
  - `enumeration_ids` EnumerationIds[]
    - `id` string, required
  - `schedule_only` boolean
  - `disable_global_alert_config` boolean
  - `disable_global_report_config` boolean
  - `disable_global_scan_config` boolean
  - `socks5_proxy` string
  - `automatic_scan` boolean
  - `scan_all_assets` boolean
  - `exclusions` string[]

## Response `200`

Example response

- object
  - `id` string
  - `message` string, required
  - `truncated-scan-targets` integer

## Other responses

- `400` — Example response
- `401` — Example response
- `500` — Example response
- `default` — Example response

## Changes

- **2025-10-28** `c9df54e2fb2c` — 1 info
  - added the new optional request property `exclusions`
- **2025-08-13** `c41cd7ae7718` — 1 warning, 2 info
  - removed the request property `enumeration_ids/items/type`
  - added the new optional request property `automatic_scan`
  - added the new optional request property `scan_all_assets`
- **2024-09-22** `407b73d9ce28` — 3 info
  - added the new optional `header` request parameter `X-Team-Id`
  - added the new optional request property `socks5_proxy`
  - added the optional property `truncated-scan-targets` to the response with the `200` status
- **2024-04-19** `ba8a20839440` — 9 breaking, 3 warning, 23 info
  - removed the media type `application/xml` for the response with the status `400`
  - removed the media type `application/xml` for the response with the status `401`
  - removed the media type `application/xml` for the response with the status `500`
  - removed the media type `multipart/form-data` for the response with the status `400`
  - …31 more
- **2024-01-31** `4f557b176ebd` — 2 breaking, 1 warning, 6 info
  - the request property `private_templates/items/contents` became required
  - the request property `private_templates/items/name` became required
  - removed the request property `scan_id`
  - added the new optional request property `alerting_config_ids`
  - …5 more

[Full history](https://skmtc.dev/projectdiscovery/apis/pdcp-api/changes/v1/scans/post.md)

---

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