Show broken link scan

GET

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

GET

/api/public/v1/site-broken-link-scans/:siteBrokenLinkScan

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

{
  "data": {
    "attributes": {
      "created_at": "2026-09-16T09:00:00.000000Z",
      "current_batch": 5,
      "error_code": null,
      "error_message": null,
      "finished_at": "2026-09-16T09:14:00.000000Z",
      "links_enumerated": 1830,
      "links_planned": 0,
      "method": "manual",
      "pages_enumerated": 240,
      "pages_planned": 0,
      "parts_done": 4,
      "parts_empty": 0,
      "parts_failed": 0,
      "parts_total": 4,
      "site_id": 12,
      "status": "done",
      "total_batches": 5,
      "type": "full",
      "updated_at": "2026-09-16T09:14:00.000000Z"
    },
    "id": "5001",
    "links": {
      "self": "https://api.modulards.com/api/public/v1/site-broken-link-scans/5001"
    },
    "type": "site-broken-link-scans"
  },
  "jsonapi": {
    "version": "1.1"
  }
}

One Broken Links Checker run by its exact id, as a JSON:API document of type site-broken-link-scans - the same attributes the listing shows (see “List broken link scans”).

Path variable siteBrokenLinkScan is the exact scan id, e.g. the id “Create broken link scans” answered, or one read from the listing.

A scan of another organization’s website answers 404. A read-only token is enough. The MCP twin is the site-broken-link-scans-show tool.

One Broken Links Checker run by its exact id, as a JSON:API document of type `site-broken-link-scans` - the same attributes the listing shows (see "List broken link scans"). Path variable `siteBrokenLinkScan` is the exact scan id, e.g. the id "Create broken link scans" answered, or one read from the listing. A scan of another organization's website answers 404. A read-only token is enough. The MCP twin is the `site-broken-link-scans-show` tool.

Authentication

AuthorizationBearer

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

Path parameters

siteBrokenLinkScanstringRequired

Response

200 - scan

dataobjectOptional

jsonapiobjectOptional

Errors

404

Not Found Error