1. Home
  2. Docs
  3. API Documentation
  4. Clients
  5. Client


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

This function allows you to view all of the details about your server, the plan you’ve purchased, how many targets you have left and more.

Roles Required: Admin.

Request Syntax


"apiKey": "string"


Request Parameters

Parameters being used in the Request

Parameter Name :


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 :


Is it Optional ? :


Successful Response


    “Error”: 0,

    “Function”: “Client”,

    “Data”: {

        “id”: 123456789,

        “token”: “Token”,

        “license”: “SeveralDomain”,

        “no_targets”: 1234,

        “max_targets”: 99999999,

        “companyname”: “Name”,

        “ip”: “”,

        “crnt_scans”: 100,

        “max_scans”: 23456,

        “active”: “true”,

        “domains”: “”,

        “time_reset”: “2022-10-23 12:34:56”,

        “email”: “[email protected]”,

        “phone”: “123456789”,

        “reseller”: 0,

        “img”: “”,

        “img_ext”: “png”,

        “white_label”: “Boolean”,

        “creation_date”: “”



Errors and their Possible Causes

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