Skip to main content
GET
Get Sitemap Settings

Authorizations

X-API-Key
string
header
required

API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys.

Response

Default Response

allowCrossSubdomainSync
boolean
required

When true, sitemap crawls keep URLs under the project's root domain (blog.example.com, shop.example.com). When false, only the project host and www are kept. PATCH only flips the flag; it does not crawl. To ingest previously filtered subdomain URLs, POST /sitemaps/:id/sync after turning this on.

slowCrawlEnabled
boolean
required

Pace page crawls at about 15 pages/min. Use for Shopify and other hosts that rate-limit crawlers.

verifiedBotMode
boolean
required

Identify sitemap and page crawls with the branded userAgent so you can whitelist it in a WAF. Most sites do not need this.

userAgent
string
required

User-Agent sent when verifiedBotMode is on. Read-only; whitelist this in Cloudflare/WAF.