Route: https://api.cytrix.io/CreateDiscovery
This feature will allow you to start a new discovery scan.
Roles Required: Admin and User.
Request Syntax
{
"apiKey": "String",
"domain": "String",
"name": "String",
"start_blackbox: True/False,
"proxy_name": "String"
}
Request Parameters
Parameters being used in the Request
Parameter Name :
apiKey
Parameter Usage and Options :
Your CYTRIX given API Key.
How do I get it ? :
Located in the “Profile” section.
Note : by default, the “API Status” is enabled, unless, the Admin has disabled it in the “Server Settings” section.
Type :
String
Is it Optional ? :
No.
Parameter Name :
domain
Parameter Usage and Options :
The URL you wish to scan.
How do I get it ? :
The URL\address that usually appears in the address bar (e.g., example.com).
Type :
String
Is it Optional ? :
No.
Parameter Name :
name
Parameter Usage and Options :
Sets the name for the scan, which will be used to label and identify your targets during the scanning process with CYTRIX.
Type :
String
Is it Optional ? :
No.
Parameter Name :
start_blackbox
Parameter Usage and Options :
Initiates a default black-box scan on the specified target using CYTRIX.
Type :
Boolean
Value :
True/False (Default False)
Is it Optional ? :
Yes.
Parameter Name:
proxy_name
Parameter Usage and Options :
Allows you to use a certain Proxy you created.
How do I get it ? :
There’s a table, containing all the proxies you created in the “Proxy” section.
Type :
String
Is it Optional ? :
No – if you wish to use a Proxy while scanning.
Successful Response
{
"Error": 0,
"Function": "CreateDiscovery",
"Data": [
{
"domain": "example.com",
"status": "OK",
"token": "xxxxxxxx-xxxx-xxx-xxxxxxxx"
}
]
}Errors and their Possible Causes
For more information, please refer to the General Errors section.