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

ScansCompleted

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

This function allows you to view all scans that were completed.

Roles Required: Admin and User. Private Users can only fetch Scans 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”: “ScansCompleted”,
“Data”: {
“Count”: 7,
“Tokens”: [
“String”,
“String”,
“String”,
“String”,
“String”,
“String”,
“String”
]
}
}

Errors and their Possible Causes

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