Sites

Create a monitor

mode is full_site (crawler discovery under the site's crawl policy) or url_set (exactly the given urls, validated against the site's hosts, patterns and the public-target policy; the whole set is refused if any entry fails). cadence is manual, daily, six_hourly or hourly, open to every organisation; each scheduled run is admitted against audit.capture when its slot arrives, and a refused run is skipped with a monitor.skipped event whose reason is the billing code. anchor_minute is minutes past midnight in timezone for daily, or within the interval otherwise.

post/v1/sites/{siteId}/monitors

Request

  • Base URL: https://api.ironfang.com/audit
  • URL: https://api.ironfang.com/audit/v1/sites/{siteId}/monitors
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Request body

anchor_minuteinteger
cadence'manual' | 'daily' | 'six_hourly' | 'hourly'
mode'full_site' | 'url_set' required
namestring
timezonestring

An IANA zone name, for example Europe/London.

urlsstring[]

Required for url_set on creation; ignored on update.

Response

Monitor with its URL set

Changes

No recorded changes to this operation across all 1 revision of this API.