List Broken Links Checker global configurations

GET

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

GET

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

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

200200 - Broken link configurations

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

Lists your Broken Links Checker global configurations: the named scan schedules you assign to websites, with what each one checks (internal links, external links, mixed content) and how it reads page content. Use it to find the id of a configuration to retrieve, update, delete or assign websites to, or to see which one new websites receive by default.

The id is also what the preset_broken_link field of “Create a Modular Connector download link” takes, to attach a configuration to a website that is being connected.

Authentication

AuthorizationBearer

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

Query parameters

filter[s]stringOptional

Free-text search over the configuration name.

filter[is_default]stringOptional

1 returns only the configuration new websites receive; 0 returns the others.

sortstringOptional

name (default), created_at or sites_count; prefix with - for descending.

page[number]stringOptional

Page number, starting at 1. Default 1.

page[size]stringOptional

Items per page, 1 to 50. Default 15.

fields[preset-broken-links]stringOptional

Sparse fieldset: only the attributes named here are answered. sites_count, the number of websites that use each configuration, is computed only when named here or when sorting by sites_count; a fieldset that names only sites_count answers only that attribute.

filter[id][]stringOptional

Exact configuration ids. Repeat the parameter for several: any of them matches.

filter[status][]stringOptional

enabled or disabled. Repeat the parameter for several: any of them matches.

Response

200 - Broken link configurations

datalist of objectsOptional

jsonapiobjectOptional

linksobjectOptional

metaobjectOptional