Retrieve a website's Broken Links Checker settings

GET

https://api.modulards.com/api/public/v1/broken-link-services/:site_preset_broken_link

GET

/api/public/v1/broken-link-services/:site_preset_broken_link

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

200200 - Broken Links service

{
  "data": {
    "attributes": {
      "broken_links_count": 10,
      "created_at": "2026-08-01T09:00:00.000000Z",
      "excluded": {
        "source_types": [
          "attachment"
        ],
        "url_patterns": [
          "/tag/"
        ]
      },
      "issues_count": 12,
      "last_request": "2026-09-10T03:00:00.000000Z",
      "last_scan_at": "2026-09-10T03:12:00.000000Z",
      "max_pages": 500,
      "mixed_content_count": 2,
      "next_request": "2026-10-04T03:17:00.000000Z",
      "pages_scanned": 240,
      "scan_status": "done",
      "schedule": {
        "day_month": 4,
        "day_week": null,
        "frequency": "monthly",
        "start_hour": "03:00",
        "timezone": "UTC"
      },
      "status": "enabled",
      "updated_at": "2026-09-17T10:00:00.000000Z"
    },
    "id": "901",
    "links": {
      "self": "https://api.modulards.com/api/public/v1/broken-link-services/901"
    },
    "relationships": {
      "preset": {
        "data": {
          "id": "42",
          "type": "preset-broken-links"
        }
      }
    },
    "type": "site-preset-broken-links"
  },
  "included": [
    {
      "attributes": {
        "check_external": false,
        "check_internal": true,
        "check_mixed_content": true,
        "created_at": "2026-09-17T10:00:00.000000Z",
        "is_default": true,
        "mode": "plain",
        "name": "Monthly check",
        "resource_types": [
          "link",
          "image",
          "script",
          "stylesheet"
        ],
        "schedule": {
          "day_month": 4,
          "day_week": null,
          "frequency": "monthly",
          "start_hour": "03:00",
          "timezone": "UTC"
        },
        "status": "enabled",
        "updated_at": "2026-09-17T10:00:00.000000Z"
      },
      "id": "42",
      "links": {
        "self": "https://api.modulards.com/api/public/v1/preset-broken-links/42"
      },
      "type": "preset-broken-links"
    }
  ],
  "jsonapi": {
    "version": "1.1"
  }
}

Returns how one website is checked for broken links: whether its automatic scans are on (a paused website can still be scanned on demand), the schedule it inherits from its global configuration, the page cap, what discovery leaves out (excluded), the results of its last scan (scan_status, last_scan_at, issues_count, broken_links_count, mixed_content_count, pages_scanned) and when the next scan runs (null while the website is paused). The values read back under the same keys “Update a website’s Broken Links Checker settings” accepts.

The id is the website’s Broken Links Checker settings id: read it from the site_preset_broken_link include of “Retrieve a website” (?include=site_preset_broken_link, which also carries the global configuration the website uses) or from meta.updated of “Assign websites to a Broken Links Checker global configuration”.

A website that was never assigned a global configuration has no Broken Links Checker settings.

Authentication

AuthorizationBearer

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

Path parameters

site_preset_broken_linkstringRequired

Query parameters

includestringOptional

Relations to add to the answer: preset (the global configuration the website uses). Without include it is answered; an empty include= answers none. Any other name answers 400.

Response

200 - Broken Links service

dataobjectOptional

includedlist of objectsOptional

jsonapiobjectOptional