schedules

Change a crawl schedule

Change one schedule of a site: any of its fields; what you leave out stays. enabled: false pauses it, max_pages: null returns it to the site's own budget. A new cron, or enabling it, sets its next run to the next slot from now. 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. It changes what crawls do, so it asks for confirmation: call it with dry_run: true to see the change, then with confirm: true. Your human sees it in the site's settings and can change it back there. A schedule that is not this site's is NOT_FOUND.

patch/v1/sites/{site}/schedules/{schedule_id}

Request

  • Base URL: https://frontshelf.io/api
  • URL: https://frontshelf.io/api/v1/sites/{site}/schedules/{schedule_id}
  • 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.

schedule_idstring required

The schedule's id (st_…), as schedules_list gives it.

Request body

namestring

A name for the schedule, up to 80 characters.

cronstring

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 nullable

The page budget of its crawls; null: 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[]

Replaces the list whole.

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

Change a crawl schedule

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.