Skip to main content
POST
Start a scan

Body

application/json
url
string
required

The page to scan. A bare hostname is treated as https://. Only public http and https addresses.

Example:

"https://example.com"

Response

Queued.

id
string
required
Example:

"cmuelrzr40001o63kiv6vveim"

status
string
required
Allowed value: "queued"
url
string
required

The URL as it will be scanned.

Example:

"https://example.com/"

statusUrl
string
required

Poll this for the result.

Example:

"https://testwebmcp.com/api/v1/scan/cmuelrzr40001o63kiv6vveim"

reportUrl
string
required

The report on the website.

Example:

"https://testwebmcp.com/scan/cmuelrzr40001o63kiv6vveim"