v1/scan/createscan

This API endpoint allows you to initiate a new scan for a specified address. You can specify the type of scan and optionally add a tag to the scan.

Request URL

curl -X POST "https://api.securitysurface.com/v1/scan/createscan" \
-H "apikey: your_api_key" \
-H "Content-Type: application/json"
-d '{"address":"https://example.com","comment":"this is a example","type":"st.fs","proxyid":"6","useragent":"Default"}'

Request Parameters

Parameter Type Location Required Description
address string content Yes e.g., example.com
comment string content Yes The comment to be used for the scan
type string content Yes st.bi Crawl Only
st.xss Cross-site Scripting
st.si SQL Injection
st.hmr Critical/High/Medium Risk
st.fs Full-scan
proxyid string content Yes The unique identifier of the proxy to be used
useragent string content Yes The user agent to be used

Response Data 


    {
         "scan_id": "79a8f8b7-7695-4b71-a800-b58d7490d735"
    }