schedules

Add a crawl schedule to a site

Add a named crawl schedule to a site: a crawl on cron (5 fields, UTC), optionally under its own max_pages, compared with the one before (auto_compare, on by default), with reports exported and the team emailed when it lands (email_on_complete, on by default). Your human sees it in the site's settings and can change or remove it there. A site whose billing is read-only cannot schedule (BILLING_REQUIRED). An agent may schedule at most 5 crawls a day for a site, every enabled schedule counted over the next 24 hours: a write past it is VALIDATION_FAILED; choose a slower schedule, or ask your human to set it in Frontshelf. Next: schedules_list to see when it runs next.

post/v1/sites/{site}/schedules

Request

  • Base URL: https://frontshelf.io/api
  • URL: https://frontshelf.io/api/v1/sites/{site}/schedules
  • Auth: HTTP bearer

Path parameters

sitestring required

Site ID (site_…), origin (https://example.com), or bare domain, resolved server-side; the response carries the canonical ID.

Request body

namestring required

A name for the schedule, up to 80 characters.

cronstring required

When it runs: a 5-field cron expression in UTC (0 3 * * 1 is Mondays at 03:00 UTC). A run that is missed is skipped, never caught up.

max_pagesinteger

The page budget of its crawls; leave it out for the site's own budget.

enabledboolean

False keeps the schedule without running it.

auto_compareboolean

Compare each crawl with the one before when it lands.

export_reportsstring[]

Report ids to export after each accepted crawl, plus pdf for the PDF report; an id the report registry does not know is refused.

email_on_completeboolean

Email the team when each crawl lands.

dry_runboolean

true: check the call and say what it would do, without doing it.

confirmboolean

true: go ahead with a change that asks for confirmation.

Response

Add a crawl schedule to a site

summarystring required

The answer in one or two sentences, with the numbers it rests on.

warningsstring[] required

What limits this answer (a cap, a read that was cut short). Empty when nothing does.

site_idstring required

The site's canonical id.

Changes

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