List Broken Links Checker configurations | Modular DS

{
  "data": [
    {
      "attributes": {
        "check_external": true,
        "check_internal": true,
        "check_mixed_content": true,
        "created_at": "2026-09-01T09:00:00.000000Z",
        "is_default": true,
        "mode": "plain",
        "name": "Weekly check",
        "resource_types": [
          "link",
          "image"
        ],
        "schedule": {
          "day_month": null,
          "day_week": "sunday",
          "frequency": "weekly",
          "start_hour": "04:00",
          "timezone": "Europe/Madrid"
        },
        "status": "enabled",
        "updated_at": "2026-09-01T09:00:00.000000Z"
      },
      "id": "3",
      "links": {
        "self": "{{base_url}}/api/public/v1/preset-broken-links/3"
      },
      "type": "preset-broken-links"
    },
    {
      "attributes": {
        "check_external": false,
        "check_internal": true,
        "check_mixed_content": false,
        "created_at": "2026-08-01T09:00:00.000000Z",
        "is_default": false,
        "mode": "render",
        "name": "Rendered pages",
        "resource_types": [
          "link",
          "image",
          "script",
          "stylesheet"
        ],
        "schedule": {
          "day_month": 1,
          "day_week": null,
          "frequency": "monthly",
          "start_hour": "05:00",
          "timezone": "Europe/Madrid"
        },
        "sites_count": 5,
        "status": "enabled",
        "updated_at": "2026-09-10T09:00:00.000000Z"
      },
      "id": "4",
      "links": {
        "self": "{{base_url}}/api/public/v1/preset-broken-links/4"
      },
      "type": "preset-broken-links"
    }
  ],
  "jsonapi": {
    "version": "1.1"
  },
  "links": {
    "first": "{{base_url}}/api/public/v1/preset-broken-links?page%5Bnumber%5D=1",
    "last": "{{base_url}}/api/public/v1/preset-broken-links?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/preset-broken-links?page%5Bnumber%5D=1"
      },
      {
        "active": false,
        "label": "Next &raquo;",
        "url": null
      }
    ],
    "path": "{{base_url}}/api/public/v1/preset-broken-links",
    "per_page": 15,
    "to": 2,
    "total": 2
  }
}

List the organization’s Broken Links Checker global configurations (presets): the named scan schedules applied to websites (what is checked: internal links, external links, mixed content; render mode), with how many websites use each and which one is the default for new websites. The id is what the preset_broken_link field of “Create connection plugin” (POST /api/public/v1/connection-plugins) takes, and what the requests under “Broken Links Configurations” address: read one in full, create, edit or delete it, and assign websites to it there.

Response fields: id, name, status (enabled, disabled), is_default, schedule (object: frequency, start_hour, timezone, day_week, day_month), check_internal, check_external, check_mixed_content, resource_types (link, image, script, stylesheet, og_image, canonical), mode (plain, render), sites_count (opt in with fields[preset-broken-links]=sites_count), created_at, updated_at.

List the organization's Broken Links Checker global configurations (presets): the named scan schedules applied to websites (what is checked: internal links, external links, mixed content; render mode), with how many websites use each and which one is the default for new websites. The id is what the `preset_broken_link` field of "Create connection plugin" (`POST /api/public/v1/connection-plugins`) takes, and what the requests under "Broken Links Configurations" address: read one in full, create, edit or delete it, and assign websites to it there. Response fields: `id`, `name`, `status` (enabled, disabled), `is_default`, `schedule` (object: `frequency`, `start_hour`, `timezone`, `day_week`, `day_month`), `check_internal`, `check_external`, `check_mixed_content`, `resource_types` (`link`, `image`, `script`, `stylesheet`, `og_image`, `canonical`), `mode` (plain, render), `sites_count` (opt in with `fields[preset-broken-links]=sites_count`), `created_at`, `updated_at`.

Authentication

AuthorizationBearer

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

Query parameters

filter[id]stringOptional

Exact configuration ids

filter[s]stringOptional

Free-text search over the configuration name

filter[is_default]stringOptional

1 = only the default configuration for new websites; 0 = the others

filter[status]stringOptional

Comma list: enabled, disabled

sortstringOptional

name (default), -name, created_at, sites_count (prefix - for descending)

page[number]stringOptional

Page number

page[size]stringOptional

Items per page, max 50

fields[preset-broken-links]stringOptional

Opt into the computed website count

Response

200 - Broken link configurations

datalist of objectsOptional

jsonapiobjectOptional

linksobjectOptional

metaobjectOptional