Set residential proxy
Turn the residential IP on or off for a computer’s Chrome, or get a new IP.
{"enabled": true}turns it on and keeps the computer’s sticky IP. It lasts up to 2 hours, and changes sooner if the home connection behind it goes offline.{"enabled": true, "new_ip": true}gets a new IP.{"enabled": false}turns it off. Chrome goes out from the data center again.
429 with retry_after.
Data
The computer draws on the workspace owner’s residential data: what the owner’s plan includes each month (1 GB on Starter, 5 GB on Growth, 20 GB on Scale and Enterprise), used first, then data bought at $3 per GB from credits. This call never buys. This month’s included data that is waiting to be added (included.waiting_bytes in Get residential proxy) isn’t data left here.
Up to 20 GB can be added to the account a UTC day, every way together: included data as it is used, purchases and card payments. The limit is on adding data, not using it: data the account already has can still be used, but nothing more is added until 00:00 UTC.
With no data left, turning it on changes nothing and answers the first of these that applies:
rate_limited also carry retryable and docs_url.
Other refusals
A409 changes nothing and names why in code:
409 with no code. On a computer set to your own proxy, these refusals other than computer_asleep come without a code.Authorizations
Body
Response
The computer's browser route after the change.
Which route the computer’s Chrome leaves through, its exit IP, and the account’s residential data. state, billing, quota.counted_at and quota.this_computer_bytes are present on a Linux computer set to the residential route, and never on a Bops computer. included is present when the owner’s plan includes data.
The computer's browser route. residential is the default. custom is your own proxy, set with POST /api/computers/{id}/egress/upstream (see Browser networking); with it, turning the relay on uses your proxy, not a residential IP.
residential, device, custom Why this computer can’t use a residential IP whatever data the account has: a Bops computer, a dedicated IP that is on, or residential IPs paused for this computer. Absent when nothing stops it. Buying data does not help while it is set.
bops_computer, dedicated_ip, paused Where the account’s data stands. none: the account has never had any. ok: some left. low: under 0.25 GB left. buying: a purchase is still finishing. out: none left, so Chrome can’t load pages until there is more. Present on a Linux computer set to the residential route, and never on a Bops computer.
none, ok, low, buying, out Whether more data can be bought now. Present with state. It carries no balance: Get residential data has that, for the owner.