Route: https://api.cytrix.io/GetProxy
function allows you to fetch an existing Proxy.
Roles Required: Admin and Users. Private Users can only Get Proxies they have created.
Request Syntax
{"apiKey": "String", "proxyName": "String"
}
Request Parameters
Parameters being used in the Request
Parameter Name :
apiKey
Parameter Usage and Options :
Your CYTRIX 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 :
proxyName
Parameter Usage and Options :
The name of the Proxy you wish to fetch.
Type :
String
Is it Optional ? :
No.
Successful Response
{
"Error": 0,
"Function": "GetProxy",
"Data": {
"id": 10,
"ip": "1.11.1.1",
"port": "123456798",
"name": "Name"
}
}
Errors and their Possible Causes
For more information, please refer to the General Errors section.