v52

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-0393116227.2 KB

crawl-settings

Update web crawl setting

Updates the setting (name, schedule) for web crawl data sources.

Required roles: All

put/crawl-settings/{id}

idstring required

Ingestion setting ID for the web crawl data source

namestring required

Name of the web crawl data source

rrulestring

Recurrence rule (RFC 5545 RRULE). Empty string or omission removes the existing schedule.

Successfully updated web crawl setting

idstring required

Web crawl ingestion setting ID

namestring required

Name of the web crawl ingestion setting

start_urlstring required

Start URL of the web crawl

path_filtersstring[]

Path filters for crawling

content_patternstring[]

Content patterns for filtering

max_depthinteger required

Maximum crawl depth

max_num_filesinteger nullable

Maximum number of files to crawl

html_onlyboolean required

When true, only HTML files will be downloaded

use_browserboolean required

Whether to use a headless browser for crawling

file_extensionsstring[]

File extensions to include (e.g. ".pdf", ".docx")

rrulestring

Recurrence rule (RFC 5545 RRULE)