Route: https://api.cytrix.io/AddProxy
This function allows you to create a desired Proxy for your own use.
Note : to use a desired proxy, insert its name as a value when starting a new scan.
Note : you can either use your own Proxy or create one, using our agents.
Roles Required: Admin, User and Private User.
Request Syntax
{
"apiKey": "String",
"ip": "String",
"port": "String",
"name": "String",
"auth": True/False,
"username": "String",
"password": "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 :
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.
Parameter Name :
auth
Parameter Usage and Options :
If authentication needed
Type :
Boolean
Is it Optional ? :
Yes.
Parameter Name :
username
Parameter Usage and Options :
username for proxy authentication
Type :
String
Is it Optional ? :
Yes.
Parameter Name :
password
Parameter Usage and Options :
Password for proxy authentication
Type :
String
Is it Optional ? :
Yes.
Successful Response
{
"Error": 0,
"Function": "AddProxy",
"Data": "Proxy 'Name' was created successfully"
}Errors and their Possible Causes
For more information, please refer to the General Errors section.