- API Reference
- Box API
- Selling platform
Let a customer set or turn off automatic IP rotation of the proxy they rent
Sets the auto-rotation interval in seconds; seconds=0 turns auto-rotation off. A non-zero value needs the seller's permission and must be at least the proxy's minimum interval and below one year. Group proxies are refused. Refusals come in data (token, permission, validation) or message (save failures).
GET
/selling/change_interval_rotationQuery parameters
tokenstringrequiredsecret
API token of one sold proxy (api_token in /selling/shared_proxies). Give it only to the customer who rents that proxy; anyone with the link can use it.
secondsintegerrequired
Interval in seconds; 0 turns auto-rotation off.
Example
600Authentication
Authenticated only by the sold proxy's API token; the dashboard login and "Basic auth for all API" do not apply.
Responses
Result or refusal.
Errors returned in msg
| msg | Meaning | What to do |
|---|---|---|
This function is available on Selling Platform license only. Please contact Administrator! | The license does not include the Selling Platform. | Upgrade the license. |
API Token invalid | Token unknown or reset (in data). | Ask the seller for the current link. |
Feature does not allowed for proxy group | The proxy is a group proxy (in data). | Not available for group proxies. |
Feature does not allowed | The seller did not allow interval changes (in data). | Ask the seller. |
Invalid param seconds | Negative or one year or more (in data). | Use 0 or a value below one year. |
Minimum allowed: Ns | Below the proxy's minimum interval (in data). | Use at least N seconds. |
Changed failed [1]! | Could not save the off setting (in message). | Retry; contact the seller. |
Changed failed [2]! | Could not save the interval (in message). | Retry; contact the seller. |
Error during change interval rotation, please contact administrator | Unexpected error (in message). | Contact the seller. |