Skip to main content
POST
Replace Proxy
Replace a single proxy IP on an order with a new, randomly selected available IP. The IP you pass must currently be assigned to the order. All other IPs on the order are untouched, and the proxy username, password, and port stay the same.
This feature requires the proxy_exchange feature to be enabled for your organization. Without it, requests return 403 Forbidden. Contact support if you need access. This endpoint only works on active datacenter orders (orders scheduled to cancel keep replace rights until they expire).
Rate limits. These calls trigger configuration reloads on the proxy servers, so they are limited two ways:
  • Per order: one replace per 60 seconds (a 429 response includes retry_after_seconds).
  • Per API key: at most 10 exchange/replace calls per minute combined, on top of the general 60 req/min limit.

Request

Headers

Path Parameters

string
required
The order ID returned from order creation.

Body Parameters

string
required
The IPv4 address to replace. Must currently belong to this order.

Example Request

Response

Success Response

Response Fields

string
Status of the request.
string
Human-readable result message.
object
Replace operation details.
string
The order ID that was processed.
string
The IP that was removed from the order.
string
The newly assigned IP.
string
The full proxy string for the new IP in ip:port:username:password format.

Error Responses

400 Bad Request - Missing Field

400 Bad Request - Invalid IP Format

400 Bad Request - IP Not On Order

400 Bad Request - Order Not Active

Same rule as exchange: scheduled-to-cancel orders keep replace rights until expiry.

400 Bad Request - Wrong Product Type

403 Forbidden - Feature Not Enabled

404 Not Found

429 Too Many Requests - Rate Limited

One replace per order is allowed every 60 seconds.

500 Internal Server Error

Nothing changed; retry or contact support.

Notes

  • The proxy username, password, and port are unchanged — only one IP is swapped
  • To replace every IP on the order at once, use Exchange Proxies
  • Use Get Order to look up the current IPs assigned to an order

Exchange Proxies

Replace all IPs on an order at once.

Get Order

Fetch the current proxy list for an order.