1. Home
  2. Docs
  3. API Documentation
  4. ServerInfo
  5. ServerInfo


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

Using this function, fetches all the information regarding your server (such as Name, Phone etc.)

Roles Required: Admin and User. Private Users can only View Server Info in their own scope.

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": "ServerInfo",
    "Data": {
        "ScansCount": 99999,
        "Edition": "Unlimited",
        "CompanyName": "Name",
        "DomainCapacity": "555555/99999999"

Errors and their Possible Causes

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