sites

Read a site's crawl settings, asked and effective

A site's crawl settings: config (what was asked for) and effective (what the next crawl will actually use), with demotions naming every difference and why. An unverified site crawls politely (2 at a time, 250 ms apart) as FrontshelfBot, with no credentials or custom headers, whatever config says: verified says which applies, and sites_verify changes it. max_urls is the page cap the crawl honours and where it comes from. Credential values are never returned. Next: configs_update to change a setting, crawls_start for a crawl under the effective settings.

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

Response

Read a site's crawl settings, asked and effective

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.