Skip to main content
AI agents are now live in Website Scanner! Enter your URL and fix website issues 3x faster with AI. Explore now!
No Result Found
Connect & Get help from fellow developers on our Discord community. Ask the CommunityAsk the Community

Trigger scan API in Website Scanner

Use this API to trigger a new run of an existing accessibility website scan.

trigger scan

POST /api/v1/scanner/scans/{project_id}/new_scan

For geo-restricted data, use the following endpoints:
https://accessibility-eu.browserstack.com/api/website-scanner/v1/scans/{scan_id}/new_scan (European Union)
https://accessibility.browserstack.com/api/website-scanner/v1/scans/{scan_id}/new_scan (United States)
https://accessibility-in.browserstack.com/api/website-scanner/v1/scans/{scan_id}/new_scan (India)

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
     -X POST "https://api-accessibility.browserstack.com/api/website-scanner/v1/scans/{scan_id}/new_scan" \
     -H "Content-Type: application/json" \

  • project_id* Integer

    The unique ID of the scan project for which you want to trigger a new run.

Response Attributes 200 OK JSON

Response

{
    "success": true,
    "data": {
        "scanRunId": 144
    }
}
  • success Boolean

    Indicates whether the request was successful.

  • data Object

    Contains the ID of the newly created scan run.

    â–¶ SHOW VALUES

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked





Thank you for your valuable feedback

Download Copy Check Circle