Create

Create a new web crawl.

Headers

AuthorizationstringRequired

Request

This endpoint expects an object.
urlstringRequiredformat: "uri">=1 character<=2083 characters
URL of the website to scan
knowledge_graphstringOptionalformat: "uuid"
the id of the knowledge graph
scan_depthintegerOptional>=1<=3Defaults to 1

How deep to crawl. 1 for single page, >1 for recursive

max_pagesintegerOptional>=1<=300Defaults to 50

Maximum number of pages to crawl. Only applies when scan_depth > 1

Response

Successful Response
idstringformat: "uuid"
createdstringformat: "date-time"
modifiedstringformat: "date-time"
urlstringformat: "uri">=1 character<=2083 characters
scan_depthinteger

How deep to crawl. 1 for single page, >1 for recursive

last_scan_datestringformat: "date-time"
crawl_statsobject or null
crawled_urlslist of any or null
website_metadataobject or null
error_detailsstring or null
is_activeboolean or nullDefaults to true
statusstring or null

Human-readable status label

Errors