List malware scans

GET

https://api.modulards.com/api/public/v1/site-scans

GET

/api/public/v1/site-scans

curl https://api.modulards.com/api/public/v1/site-scans \
     -H "Authorization: Bearer <token>"

200200 - Site scans list

{
  "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"
  },
  "links": {
    "first": "{{base_url}}/api/public/v1/site-scans?page%5Bnumber%5D=1",
    "last": "{{base_url}}/api/public/v1/site-scans?page%5Bnumber%5D=1",
    "next": null,
    "prev": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "active": false,
        "label": "&laquo; Previous",
        "url": null
      },
      {
        "active": true,
        "label": "1",
        "url": "{{base_url}}/api/public/v1/site-scans?page%5Bnumber%5D=1"
      },
      {
        "active": false,
        "label": "Next &raquo;",
        "url": null
      }
    ],
    "path": "{{base_url}}/api/public/v1/site-scans",
    "per_page": 15,
    "to": 1,
    "total": 1
  }
}

Lists the malware scans of every website your token can reach, newest first. Use filter[site][] for the scans of one or several websites, or filter[id][] to follow the scans a launch started.

A scan can take hours: read verdict (pending and in_progress mean it is still running; clean, threats_found, failed and quota_exceeded are final). omitted lists the areas skipped for lack of scan quota, with their reset dates.

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. Repeat the parameter for several: any of them matches.

filter[id][]stringOptional

Exact scan ids, for example to follow a launched batch. Repeat the parameter for several.

filter[status][]stringOptional

pending, in_progress, done, failed or quota_exceeded. Repeat the parameter for several.

filter[verdict][]stringOptional

pending, in_progress, clean, threats_found, failed or quota_exceeded. Repeat the parameter for several.

filter[method][]stringOptional

How the scan started: manual, automatic for a scheduled one, or force_first for the first automatic scan of a website. Repeat the parameter for several: any of them matches.

sortstringOptional

created_at or updated_at; prefix with - for descending. Default: -created_at (newest first).

page[number]stringOptional

Page number, starting at 1. Default 1.

page[size]stringOptional

Items per page, 1 to 50. Default 15.

includestringOptional

Relations to add to the answer: site (the website).

Response

200 - Site scans list

datalist of objectsOptional

jsonapiobjectOptional

linksobjectOptional

metaobjectOptional