No Result Found

Trigger scan API in Website Scanner

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

trigger scan

POST https://api-accessibility.browserstack.com/api/website-scanner/v1/scans/{scan_id}/new_scan

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" \

  • authConfigId* Integer

    A unique ID of the auth config to be used for the scan.

Response Attributes 200 OK JSON

Response

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

  • success Boolean

    True if the scan is triggered.

  • data Object

    Details of the scan triggered.

    ▶ SHOW VALUES

    • scanRunID Integer

      A unique ID of the scan that got triggered.

  • error Object

    Details about the error, if any, returned on trying to trigger a scan.

    ▶ SHOW VALUES

    • success Boolean

      True if successful, False if an error occurred.

    • data String

      Additional error information, if any.

    • error String

      Error message indicating the reason for failure.

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