Skip to main content
POST
/
api
/
v1
/
scans
/
start
Start a new scan
curl --request POST \
  --url https://zeropath.com/api/v1/scans/start \
  --header 'Content-Type: application/json' \
  --header 'X-ZeroPath-API-Token-Id: <api-key>' \
  --header 'X-ZeroPath-API-Token-Secret: <api-key>' \
  --data '{
  "organizationId": "<string>",
  "repositoryIds": [
    "<string>"
  ],
  "repositories": [
    {
      "id": "<string>",
      "branch": "<string>"
    }
  ],
  "scanType": "FullScan",
  "scanTargetBranch": "<string>",
  "prTargetBranch": "<string>"
}'
[
  "<string>"
]

Authorizations

​
X-ZeroPath-API-Token-Id
string
header
required
​
X-ZeroPath-API-Token-Secret
string
header
required

Body

application/json
​
organizationId
string
​
repositoryIds
string[]
​
repositories
object[]
​
scanType
enum<string>

Optional. When omitted defaults to FullScan.

Available options:
FullScan,
PrScan
​
scanTargetBranch
string

Branch to scan (source branch for PRs)

​
prTargetBranch
string

Target branch for PR merge (base branch)

Response

Scan started successfully

The response is of type string[].

⌘I