Skip to navigation

Update a Broken Links Checker global configuration

View as MarkdownOpen in Claude

Updates one Broken Links Checker global configuration. Send only the fields you want to change.

  • schedule is replaced whole: when you send it, it carries every field its frequency needs (frequency, start_hour, timezone and the day its frequency asks for); when you leave it out, the stored one stays.
  • A new schedule reaches every website that uses the configuration and reschedules their next scan.
  • default: true makes it the configuration new websites receive and takes the mark off the previous one; default: false clears it.
  • A field you send must carry a value: an explicit null or a blank string answers 422.
  • The global configuration is always enabled, so it has no status; the page cap and the exclusions are per website.

Body

All fields are optional and take the same values as in “Create a Broken Links Checker global configuration”.

  • name (string, optional): the configuration’s name.
  • schedule (object, optional): frequency, start_hour, timezone and the day its frequency asks for.
  • check_internal, check_external, check_mixed_content (boolean, optional): what the scan checks.
  • resource_types (array of strings, optional): what discovery extracts.
  • mode (plain or render, optional): how the plugin reads page content.
  • default (boolean, optional): whether new websites receive it.

Errors

  • 422: max_pages, excluded or status is sent, or a field is sent as null or blank.

Authentication

AuthorizationBearer

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

Path parameters

Request

This endpoint expects an object.
modestringOptional

Response

200 - Broken Links configuration updated

dataobjectOptional
jsonapiobjectOptional

Errors

422
Unprocessable Entity Error