sites

Change a site's crawl settings

Change a site's crawl settings: patch is any subset of configs_get's config, same snake_case keys. Sections merge key by key; a list replaces the stored list whole; in thresholds (rules_get's threshold.key, stored unit) null resets a key. Every later crawl changes, so it asks for confirmation: dry_run: true shows the change, then confirm: true. Your human can undo it in the site's settings. On an unverified site, rate_ms under 250, concurrency over 2, user_agent_preset not frontshelfbot, custom headers, robots_mode not respect, integrations.lighthouse_budget null, content.spelling.max_pages over its default answer VERIFICATION_REQUIRED naming the fields: run sites_verify first. A custom expression that does not compile is refused naming the field. Answers as configs_get.

patch/v1/sites/{site}/crawl-config

Request

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

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 site's crawl settings

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
verifiedboolean required

Whether the site's ownership is verified: an unverified site crawls politely whatever config says (sites_verify changes it).

updated_atstring nullable required

When the settings were last changed (ISO 8601); null while the site runs on the defaults.

settings_urlstring required

The site's crawl settings page in Frontshelf (app-relative), to hand your human.

Changes

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