Create a Broken Links Checker global configuration

Creates a Broken Links Checker global configuration: a named scan schedule you then assign to websites. Creating it scans nothing yet: assign websites with “Assign websites to a Broken Links Checker global configuration”.

The global configuration is always enabled and has no status: scans are paused per website, with “Update a website’s Broken Links Checker settings”. The page cap and the exclusions are per website too. A field you send must carry a value: an explicit null or a blank string answers 422, like leaving a required field out.

Body

• name (string, required): the configuration’s name, at most 255 characters.
• schedule (object, required): when scans run.
  • frequency (weekly or monthly, required): your plan decides which are available.
  • start_hour (HH:MM, required): 24 hours.
  • timezone (string, required): IANA name, for example UTC.
  • day_week (monday to sunday, required for a weekly schedule, refused otherwise).
  • day_month (integer from 1 to 31, required for a monthly schedule, refused otherwise).
• check_internal, check_external, check_mixed_content (boolean, optional): default true.
• resource_types (array of strings, optional): what discovery extracts, at least one of link, image, script, stylesheet, og_image or canonical. Default link, image, script, stylesheet.
• mode (plain or 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.

Errors

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