---
title: "Start a new scan"
method: POST
path: "/api/v1/scans/start"
tags: ["Scans"]
---

# Start a new scan

`POST /api/v1/scans/start`

## Request

- Base URL: `https://zeropath.com`
- URL: `https://zeropath.com/api/v1/scans/start`
- Auth: API key in header `X-ZeroPath-API-Token-Id` and API key in header `X-ZeroPath-API-Token-Secret`

## Request body

- StartScanInput
  - `organizationId` string
  - `repositoryIds` string[]
  - `repositories` object[]
    - `id` string, required
    - `branch` string
  - `scanType` 'FullScan': Optional. Must be FullScan when provided; PR scans are webhook-triggered.
  - `scanTargetBranch` string: Branch to scan.
  - `prTargetBranch` string: Optional comparison base branch for branch-aware scans.

## Response `200`

Scan started successfully

- string[]

## Other responses

- `400`: Bad Request
- `401`: Unauthorized

---

[API](https://skmtc.dev/zeropath/apis/zeropath-api-2.md) - [All operations](https://skmtc.dev/zeropath/apis/zeropath-api-2/llms.txt) - [OpenAPI document](https://skmtc.dev/zeropath/apis/zeropath-api-2/revisions/ea6ae4b68cd3?raw)
