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 comment to the scan.

Request URL

curl -i -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":"16","useragent":"Default"}'

Replace your_api_key with your actual API key.

Request Parameters

Parameter Type Location Required Description
address string body Yes The target address to scan, e.g., https://example.com
comment string body Yes The comment to be used for the scan
type string body 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 body Yes The unique identifier of the proxy to be used
useragent string body Yes The user agent to be used

Response Data 

{
    "status": "ss_success",
    "msg": "Your scan task has been created successfully.",
    "data": {
        "scan_id": "11a7442e-****-****-****-66532c176abb",
        "server_id": "6",
        "status": "scanning"
    }
}