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

ScansPaused

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

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

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": "ScansPaused",

    "Data": {

        "Count": 1,

        "Tokens": [

            "String"

]

     }

}

Errors and their Possible Causes

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