schedules

Delete a crawl schedule

Delete one schedule of a site; it never runs again, and the crawls it already ran stay. It asks for confirmation: call it with dry_run: true to see which schedule it would delete, then with confirm: true. To stop one for a while, schedules_update with enabled: false keeps it. A schedule that is not this site's, or is already gone, is NOT_FOUND, and nothing is deleted.

delete/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.

Query parameters

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

Delete 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.

schedule_idstring required
deletedtrue required

Changes

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