Start a scan

POSThttps://api.fortwatch.ai/app/scans

Scope scans:writeOperation ID startScan

Starts every enabled scanner on a verified asset. With issueId it re-checks that issue (its scanner runs even when turned off for the asset). 409 with the running scan when one is in progress; 403 when the daily scan limits are reached.

Request body

JSON, required.

Field	Type	Description
`assetId`	integer
`issueId`	integer

Example request

curl -X POST "https://api.fortwatch.ai/app/scans" \
  -H "Authorization: Bearer $FORTWATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "assetId": 42,
  "issueId": 42
}'

Response 201

Created.

Field	Type	Description
`id`required	number
`assetId`required	number
`status`required	string
`triggeredBy`required	string
`triggeredByUserId`required	number \| null
`failureCode`required	string \| null
`failureDetail`required	string \| null
`scannerIp`required	string \| null
`startedAt`required	string (date-time) \| null
`completedAt`required	string (date-time) \| null
`createdAt`required	string (date-time)
`updatedAt`required	string (date-time)
`asset`required	object
`id`required	number
`projectId`required	number
`name`required	string \| null
`type`required	string
`value`required	string
`status`required	string
`canonicalUrl`required	string \| null
`resolvedIp`required	string \| null
`cdnProvider`required	string \| null
`bucketProvider`required	string \| null
`lastCheckedAt`required	string (date-time) \| null
`failReason`required	string \| null
`skippedRedirectHost`required	string \| null
`disabledScannerTypes`required	string[]
`portScanMode`required	string
`nucleiMinSeverity`required	string
`ownershipVerifiedAt`required	string (date-time) \| null
`ownershipToken`required	string
`ownershipMethod`required	string \| null
`createdAt`required	string (date-time)
`updatedAt`required	string (date-time)
`project`required	object
`id`required	number
`name`required	string
`scanners`required	string[]
`forcedScanners`required	string[]
`jobsTotal`required	number
`jobsDone`required	number

json

{
  "id": 42,
  "assetId": 42,
  "status": "string",
  "triggeredBy": "string",
  "triggeredByUserId": 42,
  "failureCode": "string",
  "failureDetail": "string",
  "scannerIp": "string",
  "startedAt": "2026-10-16T12:00:00.000Z",
  "completedAt": "2026-10-16T12:00:00.000Z",
  "createdAt": "2026-10-16T12:00:00.000Z",
  "updatedAt": "2026-10-16T12:00:00.000Z",
  "asset": {
    "id": 42,
    "projectId": 42,
    "name": "Production",
    "type": "string",
    "value": "app.example.com",
    "status": "string",
    "canonicalUrl": "string",
    "resolvedIp": "string",
    "cdnProvider": "string",
    "bucketProvider": "string",
    "lastCheckedAt": "2026-10-16T12:00:00.000Z",
    "failReason": "string",
    "skippedRedirectHost": "string",
    "disabledScannerTypes": [
      "string"
    ],
    "portScanMode": "string",
    "nucleiMinSeverity": "string",
    "ownershipVerifiedAt": "2026-10-16T12:00:00.000Z",
    "ownershipToken": "string",
    "ownershipMethod": "string",
    "createdAt": "2026-10-16T12:00:00.000Z",
    "updatedAt": "2026-10-16T12:00:00.000Z",
    "project": {
      "id": 42,
      "name": "Production"
    }
  },
  "scanners": [
    "string"
  ],
  "forcedScanners": [
    "string"
  ],
  "jobsTotal": 1,
  "jobsDone": 1
}

Errors

`400`	The request is not valid: a field is missing or has the wrong shape (the message names it).
`401`	No valid credentials: the API key or access token is missing, revoked or expired (INVALID_API_KEY, INVALID_TOKEN).
`403`	Not allowed: the key or token lacks this scope (SCOPE_REQUIRED), the route is dashboard-only (SESSION_REQUIRED), or a plan limit applies.
`429`	Too many requests (RATE_LIMITED): wait the seconds Retry-After gives.

Every code is explained in Errors.

This page as Markdown