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

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.

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": ".....
                "key": "",
                "payload": "String",
                "method": "GET",
                "params": "",
                "cookies": "",
                "headers": "",
                "status_code": "0",
                "content_type": "",
                "fixed": "0",
                "token": "String"
            }
        ]
    }
}

Errors and their Possible Causes

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