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

If Geo Region Restriction (GRR) is enabled for your account, add your region code to the host name: api-accessibility-<region>.browserstack.com. See Geo Region Restriction endpoints for the region codes and examples.

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"

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
- scanRunId Integer
  
  The unique ID of the newly triggered scan run.

Did this page help you?

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

This page has exactly what I am looking for
This content & code samples are accurate and up-to-date
The content on this page is easy to understand
Other (please tell us more below)

Any additional feedback?

Thank you for your valuable feedback

Trigger scan API in Website Scanner

trigger scan

Request parameters

project_id* Integer

Response attributes 200 OK JSON

success Boolean

data Object

scanRunId Integer

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

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

project_id^* Integer

Response attributes `200 OK` `JSON`