In this article, we will talk about a method aimed at automating the work by adding an IP to the whitelist of your package or changing a previously associated IP. This is especially useful if you have a dynamic IP or you intend to work with proxies from different, constantly changing devices.

As a reminder, whitelisting your IP is required to get access to proxies when using IP authorization. You are not required to whitelist your IP when using login and password authorization. In this case, Any IP mode will be automatically enabled for your package.

Important: Any IP mode weakens the security measures used to protect your account meaning that anyone in possession of your username and password will be able to access your subscription. We recommend whitelisting your IP to ensure the maximum safety of your account. In this case, both authorization methods will work only if you are using a whitelisted IP address.


You can use API through CURL requests or using Postman. Please feel free to use the following documentation to be imported into the Postman interface.

In this article, we will show you methods in the form of curl requests for Windows 10 (the setting is described here) and iOS/Linux.

The methods use the following variables:
<api-key> - an individual API-key available in the "Profile" tab in Dashboard.

<package-key> - the login of the package, in the whitelist of which you need to make changes.

1. Get information about all available slots in the package.

For Windows 10:

curl --location --request GET "https://partner.api.soax.com/v1/account/package/<package-key>/ip-list" --header "api-key: <api-key>"

For iOS/Linux:

curl --location --request GET 'https://partner.api.soax.com/v1/account/package/<package-key>/ip-list?=' \--header 'api-key: <api-key>'

In response to the request, you receive information on each of the slots in the format:

slot IP address, slot name, slot number.


2. Update IP address in the available slots.

New variables appear in this request:

<slot_IP> - IP to be pinned to the slot;

<slot_number> - number of the slot to be changed;

<slot_name> - the name of the slot to be changed.

For Windows 10:

curl --location --request POST "https://partner.api.soax.com/v1/account/package/<package-key>/update-ip?=" --header "api-key: <api-key>" --header "Content-Type: application/json" --data-raw "[{\"ip\": \"<slot_IP>\", \"slot\": <slot_number>,\"comment\": \"<slot_name>\"}]"

For iOS/Linux:

curl --location --request POST 'https://partner.api.soax.com/v1/account/package/<package-key>/update-ip?=' \
--header 'api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '[
{
"ip": "<slot_IP>",
"slot": <slot_number>,
"comment": "<slot_name>"
},
]'

3. Delete whitelisted IP (where IP slot is not deleted but remains empty).

With this method, the slot is not removed but remains empty. There are two options:

a) By a number of IP slot:

For Windows 10:

curl --location --request POST "https://partner.api.soax.com/v1/account/package/<package-key>/detach-ip" --header "api-key: <api-key>" --header "Content-Type: application/json" --data-raw "[{\"slot\": <slot_number>}]"

For iOS/Linux:

curl --location --request POST 'https://partner.api.soax.com/v1/account/package/<package-key>/detach-ip' \
--header 'api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '[
{
"slot": <slot_number>
}
]'

b) By the IP:

For Windows 10:

curl --location --request POST "https://partner.api.soax.com/v1/account/package/<package-key>/detach-ip" --header "api-key: <api-key>" --header "Content-Type: application/json" --data-raw "[{\"ip\": \"<slot_IP>\"}]"

For iOS/Linux:

curl --location --request POST 'https://partner.api.soax.com/v1/account/package/package-key/detach-ip' \
--header 'api-key: api-key' \
--header 'Content-Type: application/json' \
--data-raw '[
{
"ip": "IP address"
}
]'

If you have any questions or issues while using the API, please contact our support team via live chat or by sending an email to [email protected].


Did this answer your question?