1. Home
  2. Docs
  3. API Documentation
  4. Proxy
  5. GetProxies

GetProxies

This function allows you to fetch multiple Proxies for your own use.

Request Syntax

{
"apiKey": "String", "name": "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.


Parameter Name :

name

Parameter Usage and Options :

The names of the proxies you wish to fetch.

Type :

String

Is it Optional ? :

No.


Successful Response

{
    "Error": 0,
    "Function": "GetProxies",
    "Data": [
        {
            "id": 123456,
            "ip": "11.1.1.11",
            "port": "123465",
            "name": "Name"
        },
        {
            "id": 123456,
            "ip": "11.1.1.11",
            "port": "123465",
            "name": "Name"
        }
        
    ]
}

Errors and their Possible Causes

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