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

ServerInfo

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

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

Errors and their Possible Causes

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