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","tag":"this is a example","type":"st.fs"}'

Request Parameters

Parameter Type Location Required Description
address string content Yes e.g., example.com
tag string content Yes
type string content Yes

Response Data 


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