The Security For Everyone API provides ability to use all of our tools with a simple GET request.
This reference includes API documentation for the tools available on our website. In this way, our members can use the tools as they wish.
A simple GET request can start any tool you want. All response data is returned in JSON format.
Since we are using a queue mechanism, we create a job for you whenever you make an API request to create scan. We return an analysis ID to query status of the scan (job).
Before we get started, it's good to know:
To keep it simple we use only GET method. There is to type of request.
Scan request example :
Result request example :
|scan||string||True||Name of the scan. See full list here.|
|asset||string||True||Asset you want to use in scan. Domain, IP or URL.|
|token||string||True||Token value in your profile page.|
|analysis_id||string||True||ID of a scan.|
|output_type||string||False||Detailed or compact output type. Default is compact.|
All actions should return HTTP 200 status code. There are two types of response. First one is the response of create job request:
Second is the response of get scan result request:
|status_code||string||Status code, see full list|
|analysis_id||string||UUID for analysis, use this ID to get analysis result.|
|output||object||Scan names and scan results.|
|asset||string||Asset name for the scan.|
Get result of a scan:
List of status code
|ok||The request was successful. No error.|
|not_valid_api_key||The API key is not valid.|
|api_key_not_authorized||The API key is not authorized to perform analysis. Usually need to upgrade your package.|
|not_valid_asset||IP, Domain or URL is not valid. Please contact with us if you want to scan a TLD that is not in our white list.|
|too_many_request||You have hit the rate limit|
|not_valid_scan_name||The scan name is not valid.|
|not_valid_output_type||The output type name is not valid.|
|internal_error||Please contact with us|
|missing_param||At least one parameter is missing|
|asset_type_error||Asset type mismatch (Domain or IP)|
|not_finished||At least one scan has not finished yet.|
|analysis_not_found||Can not find any scan result for that analysis id.|