API Referencecrawls

Cancel

Cancel a website scan.

Path parameters

idstringRequired

Headers

AuthorizationstringRequired

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"
statusstring or null

Human-readable status label

crawl_statsmap from strings to any or null
crawled_urlslist of any or null
website_metadatamap from strings to any or null
error_detailsstring or null
is_activeboolean or nullDefaults to true

Errors