Route: https://api.cytrix.io/AddSubdomain
This feature allows you to add a subdomain/s to the target list.
Note: You can add a subdomain even after the scan is complete.
Roles Required: Admin and User.
Request Syntax
{
"apiKey": "String",
"token": "String",
"subdomain": "String",
"subdomain_file": "String",
"start_blackbox": True/False
}
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 :
token
Parameter Usage and Options :
The scan’s token.
How do I get it ? :
Simply use “GetAllDiscovery” function, or navigate to a certain scan’s page, and in the address bar, you will notice “token=String”, use that String.
Type :
String
Is it Optional ? :
No.
Parameter Name :
subdomain
Parameter Usage and Options :
The subdomain you wish to scan.
How do I get it ? :
The URL\address that usually appears in the address bar (e.g., www.example.com).
Type :
String
Is it Optional ? :
No.
Parameter Name :
subdomain_file
Parameter Usage and Options :
In case Users wants to initiate Multiple scans with multiple targets using an .xlsx File. Insert the exact full name of the File as it’s saved in the Storage. For example: file1.xlsx –> file1.xlsx .
Type :
String
Is it Optional ? :
If you wish to use an .xlsx file, then 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.
Successful Response
{
"Error": 0,
"Function": "AddSubdomain",
"Data": [
{
"domain": "www.example.com",
"status": "OK",
"token": "xxxxxxxx-xxxx-xxx-xxxxxxxx"
}
]
}Errors and their Possible Causes
For more information, please refer to the General Errors section.