POST
/
v1
/
proxies
/
swap
/
{proxyName}
curl --request POST \
  --url https://cmd.illusory.io/v1/proxies/swap/{proxyName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "isp": "Verizon",
  "location": "Austin",
  "copy_settings": true
}'
{
  "ok": true,
  "message": "Proxy swap command sent to device successfully.",
  "data": {
    "proxy_name": "ILL-US-AU1-9999"
  }
}

Swap a proxy server for a new one from any available ISP and location. This will remove the old proxy server and replace it with a new one.

The name of the proxy and port will change after swapping. The server IP may change as well. You have the option to use copy_settings to transfer configurations like: auto_change, auto_change_time, auth_method, username, password and whitelist.

Authorizations

​
Authorization
string
header
required

The Authorization header is used to authenticate with the API using your Master API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

​
proxyName
string
required

Replace {proxyName} in the url path with YOUR_PROXY.

Body

application/json
Swap proxy details
​
isp
string
required

Name of the Internet Service Provider e.g. Verizon

Example:

"Verizon"

​
location
string
required

City of the proxy server e.g. Austin

Example:

"Austin"

​
copy_settings
boolean

Indicates whether to copy the settings of the proxy being swapped with. Default: false

Example:

true

Response

202
application/json
Server response
​
ok
boolean

Indicates whether the request was successful e.g., true

​
message
string

Success message

Example:

"Proxy swap command sent to device successfully."

​
data
object

Was this page helpful?

Suggest edits