AppScan
Browse all 61 articles
API

Sites and scans

Sites, manual scans, domain verification, monitoring mode, the profile and the overview.

MethodPathNeedsReturns
POST/sitessite.create201 site; the url is normalized to its origin
GET/sitessite.readpaginated
GET/sites/:siteIdsite.readsite
POST/sites/:siteId/archivesite.delete204
PATCH/sites/:siteId/monitoringsite.update{ usageMode?, scheduledAiReview?, aiChangeVerification? }
GET/sites/:siteId/verificationsite.readverified, method, the token and how to publish it
POST/sites/:siteId/verification/checksite.update{ method: DNS_TXT | WELL_KNOWN | HTML_META }
POST/sites/:siteId/scansscan.start202 { scan, joinedExistingScan }
GET/sites/:siteId/scansscan.readpaginated
GET/scans/:scanIdscan.readscan with steps[] and coverage
GET/sites/:siteId/profilesite.readevery knowledge domain, with confidence and provenance
GET/sites/:siteId/live-profilesite.readwhat the last live scan saw, area by area
GET/sites/:siteId/overviewsite.readthe App Overview read model
GET/sites-healthsite.readper-site health for lists
GET/activity?siteId=activity.readpaginated stream of meaningful events

One scan runs per site at a time; a second request joins the running one and says so. The organization’s concurrency limit and the per-site cooldown are enforced on the server and answered with SCAN_COOLDOWN or TOO_MANY_ACTIVE_SCANS. Manual live-site scans cost no credits on paid plans.

Something here wrong, missing or out of date? Tell us and we will fix the page.