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

DeleteProxy

You can use this function to delete existing Proxy.

Note : there’s a table in the “Proxy” section, containing al the proxies you’ve created.

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 name of the proxy you wish to delete.

Type :

String

Is it Optional ? :

No.


Successful Response

{
    "Error": 0,
    "Function": "DeleteProxy",
    "Data": "Delete proxies name Name"
}

Errors and their Possible Causes

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