FortWatchFortWatchDocs
Menu

Get a scan

GEThttps://api.fortwatch.ai/app/scans/{id}
Scope scans:readOperation ID getScan

One scan with its status, timing, scanners and finding counts; a failed scan says why when the host was the reason.

Parameters

NameInTypeDescription
idrequiredpathinteger

Example request

curl -X GET "https://api.fortwatch.ai/app/scans/42" \
  -H "Authorization: Bearer $FORTWATCH_API_KEY"

Response 200

The request succeeded.

FieldTypeDescription
scanrequiredobject
idrequirednumber
assetIdrequirednumber
statusrequiredstring
triggeredByrequiredstring
triggeredByUserIdrequirednumber | null
failureCoderequiredstring | null
failureDetailrequiredstring | null
scannerIprequiredstring | null
startedAtrequiredstring (date-time) | null
completedAtrequiredstring (date-time) | null
createdAtrequiredstring (date-time)
updatedAtrequiredstring (date-time)
assetrequiredobject
idrequirednumber
namerequiredobject | null
valuerequiredstring
typerequiredstring
projectrequiredobject
_countrequiredobject
findingsrequirednumber
summaryrequiredobject
criticalrequirednumber
highrequirednumber
mediumrequirednumber
lowrequirednumber
inforequirednumber
json
{
  "scan": {
    "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,
      "name": {},
      "value": "app.example.com",
      "type": "string",
      "project": {
        "id": null,
        "name": null
      }
    },
    "_count": {
      "findings": 1
    }
  },
  "summary": {
    "critical": 1,
    "high": 1,
    "medium": 1,
    "low": 1,
    "info": 1
  }
}

Errors

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