1. Home
  2. Docs
  3. API Documentation
  4. Scans – Get
  5. GetScanIP

GetScanIP

Route: https://api.kayran.live/GetScanIP

This function will allow you to view the Scan IP that is used on a specific Scan.

This function requires roles of both Admin and User. Private Users are limited to fetching only from 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”: “GetScanIP”,

    “Data”: {

        “Scan IP”: “255.255.255.255”

    }

}

Errors and their Possible Causes

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