Show Broken Links configuration | Modular DS

{
  "data": {
    "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"
  }
}

Response attributes: name, status (enabled, disabled - the configuration itself is always enabled; scans are paused per website), is_default, schedule (object: frequency - weekly, monthly; start_hour - HH:MM; timezone; day_week; day_month), check_internal, check_external, check_mixed_content, resource_types (link, image, script, stylesheet, og_image, canonical), mode (plain, render), created_at, updated_at. sites_count, how many websites use the configuration, is opt in with fields[preset-broken-links]=sites_count.

A configuration of another organization answers 404.

Read one Broken Links Checker global configuration in full: its schedule, what it checks, how the plugin reads page content and whether it is the default for new websites. Ids come from "List broken link presets". Response attributes: `name`, `status` (enabled, disabled - the configuration itself is always enabled; scans are paused per website), `is_default`, `schedule` (object: `frequency` - weekly, monthly; `start_hour` - HH:MM; `timezone`; `day_week`; `day_month`), `check_internal`, `check_external`, `check_mixed_content`, `resource_types` (`link`, `image`, `script`, `stylesheet`, `og_image`, `canonical`), `mode` (`plain`, `render`), `created_at`, `updated_at`. `sites_count`, how many websites use the configuration, is opt in with `fields[preset-broken-links]=sites_count`. A configuration of another organization answers 404.

Authentication

AuthorizationBearer

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

Path parameters

preset_broken_linkstringRequired

Query parameters

fields[preset-broken-links]stringOptional

Opt into the computed website count

Response

200 - Broken Links configuration

dataobjectOptional

jsonapiobjectOptional

A configuration of another organization answers 404.