Retrieve a Broken Links Checker global configuration

GET

https://api.modulards.com/api/public/v1/preset-broken-links/:preset_broken_link

GET

/api/public/v1/preset-broken-links/:preset_broken_link

curl https://api.modulards.com/api/public/v1/preset-broken-links/preset_broken_link \
     -H "Authorization: Bearer <token>"

200200 - Broken Links configuration

{
  "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"
      },
      "sites_count": 3,
      "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 one Broken Links Checker global configuration: its schedule, what it checks (internal links, external links, mixed content and the resource types), how the plugin reads page content (mode) and whether new websites receive it by default. Ids come from “List Broken Links Checker global configurations”.

A global configuration is always enabled: scans are paused per website. Unlike the list, the answer always carries sites_count, the number of websites that use the configuration.

Authentication

AuthorizationBearer

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

Path parameters

preset_broken_linkstringRequired

Response

200 - Broken Links configuration

dataobjectOptional

jsonapiobjectOptional