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

SearchScan

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

This function provides access to view the queue of reports.

This function requires roles of both Admin and User. Private Users are limited to fetching only from reports they initiated.

Request Syntax

{

"apiKey": "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.


Successful Response

{

    “Error”: 0,

    “Function”: “SearchScan”,

    “Data”: {

        “Count”: 1,

        “Tokens”: [

            “xxxxx-1111-1111-xxxxxx”

        ]

    }

}

Errors and their Possible Causes

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