Crawl Settings

Update the team's crawl settings

Changed on

Changes how SnowSEO crawls and audits this site. Affects future scheduled work for SEO audits, PageSpeed and GEO — turning on auto-crawl or auto-PageSpeed causes recurring credit and quota spend, so confirm with the user first. Only the fields you send are changed. Call crawl_settings first to see the current values.

patch/v3/settings/crawling

Request

  • Base URL: https://api.snowseo.com
  • URL: https://api.snowseo.com/v3/settings/crawling
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Request body

teamIdstring required

SnowSEO team ID. Call list_teams first to choose a team.

linkstring

Optional site URL. Defaults to the team's configured website.

autoCrawlboolean

Re-crawl and re-audit the site on a schedule.

crawlingFrequencystring nullable

How often auto-crawl runs, e.g. weekly. Null clears it.

autoPageSpeedboolean

Re-run PageSpeed on a schedule. Consumes PageSpeed quota every cycle.

pageSpeedFrequencystring nullable

How often auto-PageSpeed runs. Null clears it. Also controls how long stored results are considered fresh.

autoIndexNowboolean

Automatically submit new and changed URLs to IndexNow.

selectedSitemapsstring[]

Sitemap URLs to crawl from.

selectedSubdomainsstring[]

Subdomains treated as part of this site. Pages on other hosts are flagged out of scope.

excludedUrlsstring[]

URL patterns to exclude from crawling and auditing. Replaces the whole list; use addExcludedUrls / removeExcludedUrls to change part of it.

addExcludedUrlsstring[]

URL patterns to add to the exclusion list. Ignored when excludedUrls is sent.

removeExcludedUrlsstring[]

URL patterns to remove from the exclusion list. Ignored when excludedUrls is sent.

Response

Default Response

okboolean
domainstring
autoCrawlboolean
crawlingFrequencystring nullable
autoPageSpeedboolean
autoIndexNowboolean
noUrlsFoundboolean
messagestring
changedPagesinteger

Changes

  • 2f74a3484a65Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

  • 3976341798f4Revision changes
    • info

      added the media type application/json for the response with the status