Create Broken Links configuration | Modular DS

curl -X POST https://api.modulards.com/api/public/v1/preset-broken-links \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "check_external": false,
  "default": true,
  "name": "Monthly check",
  "schedule": {
    "day_month": 4,
    "frequency": "monthly",
    "start_hour": "03:00",
    "timezone": "UTC"
  }
}'

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

Creates a Broken Links Checker global configuration: a named scan schedule you then assign to websites. Answers 201 with the configuration document and a Location header. Creating it scans nothing yet - assign websites with “Assign websites to a Broken Links configuration”.

Body (JSON):

name (string, required, max 255).
schedule (object, required): frequency (weekly, monthly - your plan decides which are available), start_hour (HH:MM, 24 hours), timezone (IANA name, e.g. UTC), day_week (monday … sunday; required for a weekly schedule, refused otherwise), day_month (1-31; required for a monthly schedule, refused otherwise).
check_internal, check_external, check_mixed_content (boolean, optional, default true).
resource_types (array, optional, min 1; default link, image, script, stylesheet) - what the discovery extracts: link, image, script, stylesheet, og_image, canonical.
mode (plain, render; optional, default plain) - render runs WordPress filters on the page content first and loads the website more.
default (boolean, optional) - true makes it the configuration new websites receive; the response reads it back as is_default.

A sent field must carry a value: an explicit null or a blank string answers 422, the same as leaving a required field out.

The configuration itself is always enabled and is not part of this payload: scans are paused per website, in “Update Broken Links service”. The page cap and exclusions are per website too, never here: sending max_pages or excluded answers 422.

Requires a full-access token (read-only tokens answer 403). Validation failures answer 422 with a JSON:API errors document.

Creates a Broken Links Checker global configuration: a named scan schedule you then assign to websites. Answers **201** with the configuration document and a `Location` header. Creating it scans nothing yet - assign websites with "Assign websites to a Broken Links configuration". **Body** (JSON): - `name` (string, required, max 255). - `schedule` (object, required): `frequency` (`weekly`, `monthly` - your plan decides which are available), `start_hour` (`HH:MM`, 24 hours), `timezone` (IANA name, e.g. `UTC`), `day_week` (`monday` ... `sunday`; required for a weekly schedule, refused otherwise), `day_month` (1-31; required for a monthly schedule, refused otherwise). - `check_internal`, `check_external`, `check_mixed_content` (boolean, optional, default `true`). - `resource_types` (array, optional, min 1; default `link`, `image`, `script`, `stylesheet`) - what the discovery extracts: `link`, `image`, `script`, `stylesheet`, `og_image`, `canonical`. - `mode` (`plain`, `render`; optional, default `plain`) - `render` runs WordPress filters on the page content first and loads the website more. - `default` (boolean, optional) - `true` makes it the configuration new websites receive; the response reads it back as `is_default`. A sent field must carry a value: an explicit `null` or a blank string answers 422, the same as leaving a required field out. The configuration itself is always enabled and is not part of this payload: scans are paused per website, in "Update Broken Links service". The page cap and exclusions are per website too, never here: sending `max_pages` or `excluded` answers 422. Requires a full-access token (read-only tokens answer 403). Validation failures answer 422 with a JSON:API `errors` document.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

check_externalbooleanOptional

defaultbooleanOptional

namestringOptional

scheduleobjectOptional

Response headers

LocationstringOptional

Response

201 - Broken Links configuration created

dataobjectOptional

jsonapiobjectOptional

Errors

422

Unprocessable Entity Error

Body (JSON):

name (string, required, max 255).
schedule (object, required): frequency (weekly, monthly - your plan decides which are available), start_hour (HH:MM, 24 hours), timezone (IANA name, e.g. UTC), day_week (monday … sunday; required for a weekly schedule, refused otherwise), day_month (1-31; required for a monthly schedule, refused otherwise).
check_internal, check_external, check_mixed_content (boolean, optional, default true).
resource_types (array, optional, min 1; default link, image, script, stylesheet) - what the discovery extracts: link, image, script, stylesheet, og_image, canonical.
mode (plain, render; optional, default plain) - render runs WordPress filters on the page content first and loads the website more.
default (boolean, optional) - true makes it the configuration new websites receive; the response reads it back as is_default.

A sent field must carry a value: an explicit null or a blank string answers 422, the same as leaving a required field out.

Requires a full-access token (read-only tokens answer 403). Validation failures answer 422 with a JSON:API errors document.