Update a Broken Links Checker global configuration
Updates one Broken Links Checker global configuration. Send only the fields you want to change.
scheduleis replaced whole: when you send it, it carries every field its frequency needs (frequency,start_hour,timezoneand 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: truemakes it the configuration new websites receive and takes the mark off the previous one;default: falseclears it.- A field you send must carry a value: an explicit
nullor 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,timezoneand 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(plainorrender, optional): how the plugin reads page content.default(boolean, optional): whether new websites receive it.
Errors
- 422:
max_pages,excludedorstatusis sent, or a field is sent asnullor blank.
Authentication
AuthorizationBearer
Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.
Path parameters
preset_broken_link
Request
This endpoint expects an object.
mode
Response
200 - Broken Links configuration updated
data
jsonapi
Errors
422
Unprocessable Entity Error
