Scanner

Trigger a scan

Triggers a new cookie/script scan for a site. Optionally provide a specific URL to scan.

post/sites/{id}/scan

Request

  • Base URL: http://localhost:3001/api/v1
  • URL: http://localhost:3001/api/v1/sites/{id}/scan
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Site ID

Example:550e8400-e29b-41d4-a716-446655440000

Request body

urlstring uri
urlsstring[]
storefrontPasswordstring

Response

Scan created

idstring uuid required
siteIdstring uuid required
urlstring required
status'completed' | 'failed' required
detectedServicesunknown
unrecognizedScriptsunknown
errorMessagestring nullable required
createdAtstring required

Changes

No recorded changes to this operation across all 1 revision of this API.