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

AddProxy

This function allows you to create a desired Proxy for your own use.

Note : to use a desired proxy, insert it’s name as a value when starting a new scan.

Note : you can either use your own Proxy or create one, using our agents.

Request Syntax

{
"apiKey": "String",
"ip": "String",
"port": "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 :

ip

Parameter Usage and Options :

The IP of your proxy.

Type :

String

Is it Optional ? :

No.


Parameter Name :

port

Parameter Usage and Options :

The port you would like to be used.

Type :

String

Is it Optional ? :

No.


Parameter Name :

name

Parameter Usage and Options :

The name you want to give to the proxy you’ll create.

Type :

String

Is it Optional ? :

No.


Successful Response

{
    "Error": 0,
    "Function": "AddProxy",
    "Data": "Proxy Name created Successes."
}

Errors and their Possible Causes

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