1. Home
  2. Docs
  3. API Documentation
  4. Scans
  5. GetScan

GetScan

Route: https://kayran.live/api/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 Kayran 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": 0,
    "Function": "GetScan",
    "Data": {
        "id": 12345678965,
        "url": "URL",
        "base_url": "URL",
        "description": "description",
        "protocol": "http",
        "tls_version": null,
        "ip": "1.1.1.1",
        "server": "Unknown",
        "os_type": "Linux",
        "technologies": "PHP",
        "speed": 10,
        "scan_duration": "0:00:02",
        "response_time": 0.12346678,
        "num_vulns": 9,
        "num_info": 0,
        "num_low": 8,
        "num_med": 1,
        "num_high": 0,
        "avg_threat": "Low",
        "exclude": "{\"list\": []}",
        "ports": null,
        "ports_num": 0,
        "links": null,
        "show_links": ".....
         "link_folders": null,
        "subdomains": [
            "webmail.attackit.co.il",
        ],
        "subdomains_num": 5,
        "token": "String",
        "in_progress": "False",
        "date": "2022-10-13 08:07:48",
        "user_id": "45",
        "status": "Completed",
        "headers": "{}",
        "cookies": "",
        "search_list": "1,4,5,6,7,8,10,11",
        "single_check": "False",
        "url_login": "",
        "user_login": "",
        "percent": 0,
        "list_paths": "",
        "new_headers": "",
        "shodan_info": "[]",
        "shodan_main": "[]",
        "project_id": 123456,
        "whois": null,
        "emails_enum": "{}",
        "responsive": "True",
        "is_spa": "False",
        "started": "False",
        "login_method": "",
        "waiting_forlogin": "true",
        "enumeration": "False",
        "profile_login_id": 0,
        "level_deep": 3,
        "auto_speed": "True",
        "proxy_id": 0,
        "api_target": "",
        "fixed_ip": "False",
        "login_localStorage": "",
        "login_sessionStorage": "",
        "login_localCookies": "",
        "server_ip": "1.1.1.1",
        "dialog": "False",
        "login_headers": "",
        "structure_links": {
            "1": "",
            "2": ".listing",
            }
        ]
    }
}

Errors and their Possible Causes

For more information, please refer to the General Errors section.