Route: https://api.cytrix.io/GetScan
This function will allow you to view a specific scan.
Note : if the user does not have the required permission, he will not be able to view the scan.
Roles Required: Admin and User. Private Users can only fetch Scans they initiated.
Request Syntax
{
"apiKey": "string",
"token": "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 :
token
Parameter Usage and Options :
The scan’s token.
How do I get it ? :
Simply use the “GetScan” or “GetAllScans” 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.
Successful Response
{
"Error": "int",
"Function": "string",
"Data": {
"id": "int",
"url": "string",
"base_url": "string",
"description": "string",
"protocol": "string",
"tls_version": "null",
"ip": "string",
"server": "string",
"os_type": "string",
"technologies": "null",
"speed": "int",
"scan_duration": "string",
"response_time": "float",
"num_vulns": "int",
"num_info": "int",
"num_low": "int",
"num_med": "int",
"num_high": "int",
"avg_threat": "string",
"exclude": "string",
"ports": "array",
"ports_num": "int",
"links": "null",
"link_folders": "null",
"subdomains": "array",
"subdomains_num": "int",
"token": "string",
"in_progress": "boolean",
"date": "string",
"user_id": "string",
"status": "string",
"headers": "string",
"cookies": "string",
"search_list": "string",
"single_check": "boolean",
"percent": "float",
"list_paths": "string",
"new_headers": "string",
"shodan_info": "array",
"shodan_main": "array",
"project_id": "int",
"whois": "string",
"emails_enum": "string",
"responsive": "string",
"is_spa": "string",
"started": "boolean",
"login_method": "string",
"waiting_forlogin": "boolean",
"enumeration": "boolean",
"profile_login_id": "int",
"level_deep": "int",
"auto_speed": "boolean",
"proxy_id": "int",
"pfx_file": "string",
"api_target": "string",
"file_crawler": "string",
"fixed_ip": "boolean",
"login_localStorage": "string",
"login_sessionStorage": "string",
"login_localCookies": "string",
"server_ip": "string",
"api_schema": "string",
"dialog": "boolean",
"login_headers": "string",
"mobile": "boolean",
"SPA": "boolean",
"link_checked": "string",
"structure_links": {
"string": "string",
"personalarea": {
"Login": {
"int": "string"
},
"dashboard": {
"int": "string"
}
}
},
"detect_SPA": "boolean",
"ns_record": "string",
"geo_ip": "string",
"external_links": "string",
"duration_limit": "string",
"jira_id": "int",
"modifier_email": "string",
"robots_txt": "string",
"sitemap_xml": "string",
"just_cves": "boolean",
"vuln_id": "string",
"refresh_token": "boolean",
"stored": "boolean",
"use_payloads": "boolean",
"scan_subdomains": "boolean",
"all_ports": "boolean",
"scan_ports": "boolean",
"login_name": "string",
"techs_len": "int",
"external_links_len": "int",
"event_log_upload": "boolean",
"lest_status_change_date": "string",
"include": "array",
"vpn_conf_name": "string",
"crt_name": "string",
"key_name": "string",
"status_code": "string",
"first_status_code": "string",
"login_image": "string",
"current_level_deep": "int",
"monday_project": "string",
"postmen_env": "string",
"duration_status": "string",
"forms": "int",
"crnt_forms": "int",
"event_log": "array",
"api_schema_status": "boolean",
"num_paths": "int",
"vulns": [
{
"id": "int",
"url": "string",
"action": "string",
"vuln_name": "string",
"severity": "string",
"method": "string",
"fixed": "int",
"user_append": "boolean"
}
]
}
}
Errors and their Possible Causes
For more information, please refer to the General Errors section.