List site scans | Modular DS | API documentation

{
  "data": [
    {
      "attributes": {
        "comment": null,
        "created_at": "2026-09-18T09:00:00.000000Z",
        "db_threats_detected": 0,
        "files_clean": 4210,
        "files_infected": 0,
        "files_malicious": 0,
        "files_suspicious": 0,
        "has_threats": false,
        "method": "manual",
        "omitted": [],
        "site_id": 101,
        "status": "done",
        "updated_at": "2026-09-18T09:14:00.000000Z",
        "verdict": "clean"
      },
      "id": "3021",
      "links": {
        "self": "https://api.modulards.com/api/public/v1/site-scans/3021"
      },
      "type": "site-scans"
    }
  ],
  "jsonapi": {
    "version": "1.1"
  },
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 1
  }
}

Lists malware scans across every website the token can reach, newest first. Narrow with filter[site][] for one or more websites, or filter[id][] to follow the scans a launch just started.

Response attributes: site_id, status (pending, in_progress, done, failed, quota_exceeded), verdict (pending, in_progress, clean, threats_found, failed, quota_exceeded), method (automatic, manual, force_first), files_clean, files_malicious, files_suspicious, files_infected, db_threats_detected, has_threats, comment, omitted (branches skipped for lack of scan quota, with their reset dates) and the timestamps. include=site adds the website to included.

Lists malware scans across every website the token can reach, newest first. Narrow with `filter[site][]` for one or more websites, or `filter[id][]` to follow the scans a launch just started. Response attributes: `site_id`, `status` (pending, in_progress, done, failed, quota_exceeded), `verdict` (pending, in_progress, clean, threats_found, failed, quota_exceeded), `method` (automatic, manual, force_first), `files_clean`, `files_malicious`, `files_suspicious`, `files_infected`, `db_threats_detected`, `has_threats`, `comment`, `omitted` (branches skipped for lack of scan quota, with their reset dates) and the timestamps. `include=site` adds the website to `included`.

Authentication

AuthorizationBearer

Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.

Query parameters

filter[site][]stringOptional

Exact website ids (repeatable)

filter[id][]stringOptional

Exact scan ids, to follow a launched batch (repeatable)

filter[status][]stringOptional

pending | in_progress | done | failed | quota_exceeded (repeatable)

filter[verdict][]stringOptional

filter[method][]stringOptional

automatic | manual | force_first (repeatable)

sortstringOptional

created_at, updated_at; prefix with - to invert. Default: -created_at (newest first)

page[number]stringOptional

page[size]stringOptional

Max 50

includestringOptional

Adds the website to included

Response

200 - Site scans list

datalist of objectsOptional

jsonapiobjectOptional

metaobjectOptional