Skip to content

Commit 8f87b80

Browse files
Docs: Update for Node SDK 0.142.0
1 parent a898fca commit 8f87b80

5 files changed

Lines changed: 10 additions & 9 deletions

File tree

‎auth/configuration.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -685,7 +685,7 @@ Pin the auth flow to a specific [proxy](/proxies/overview) so logins, health che
685685

686686
How stable the exit IP is depends on the proxy type:
687687

688-
- **[ISP](/proxies/isp)** proxies provide a static exit IP that persists across sessions, so the initial login, health checks, and reauths all exit through the same IP. The IP only changes in rare ISP-initiated replacement events or a temporary [failover to a backup endpoint](/proxies/isp#backup-endpoint-failover).
688+
- **[ISP](/proxies/isp)** proxies provide a static exit IP that persists across sessions, so the initial login, health checks, and reauths all exit through the same IP. The primary IP stays fixed unless you move a proxy backed by a reserved ISP allocation or an ISP initiates a replacement; traffic can temporarily use a different IP during a [failover to a backup endpoint](/proxies/isp#backup-endpoint-failover).
689689
- **[Residential](/proxies/residential)** proxies rotate IPs per connection — use them when you need legitimacy from a real ISP pool but can tolerate IP changes.
690690
- **[Custom (BYO)](/proxies/custom)** proxies route through whatever you point them at, so pick one if the static IP must be infrastructure you control (e.g. an allowlisted egress your security team owns).
691691

‎browsers/viewport.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ Kernel supports specific viewport configurations tuned for optimal performance a
198198
| Mobile | 390 | 844 | 60 Hz |
199199

200200
When specifying a viewport:
201-
- **Width** and **Height** are required
201+
- **Width** and **Height** are required. Headful browsers require each dimension to be at least 64 pixels; headless browsers accept any positive integer.
202202
- **Viewport configurations** outside of the supported list are available, but they are provided on a "use at your own risk" basis and may not work as expected.
203203
- **Refresh Rate** is optional - if omitted, it will be automatically determined from the width and height combination
204204

‎info/api-key-permissions.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@ Resources must be inside the new key's organization, or its project for a projec
5151
| Action | Allows |
5252
| --- | --- |
5353
| `proxies:create` | Create proxies. Grant it on a project or organization. |
54-
| `proxies:read` | List proxies and view their configuration, without credentials. |
54+
| `proxies:read` | List proxies and reserved ISP IPs, and view proxy configuration without credentials. Reserved IP inventory requires a grant on the whole project or organization. |
5555
| `proxies:use` | Select saved proxies for browsers and run health checks. |
56-
| `proxies:write` | Rename proxies. |
56+
| `proxies:write` | Rename proxies and move ISP proxies to reserved exit IPs. |
5757
| `proxies:delete` | Delete proxies. |
5858

5959
## Operations that need more than one action

‎proxies/isp.mdx‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ISP (Internet Service Provider) proxies are hosted on datacenter infrastructure
66

77
## IP rotation behavior
88

9-
ISP proxies provide a **static exit IP that persists across sessions** — every tab, request, reconnection, and future browser session attached to this proxy exits through the same IP. The IP only changes in rare ISP-initiated replacement events.
9+
ISP proxies provide a **static exit IP that persists across sessions** — every tab, request, reconnection, and future browser session attached to this proxy exits through the same IP. The primary IP stays fixed unless you move a proxy backed by a reserved ISP allocation or an ISP initiates a replacement.
1010

1111
This makes ISP proxies suitable for use cases that require a stable IP, such as IP allowlists or [managed auth](/auth/managed-auth) health checks. For comparison with other proxy types, see [IP rotation behavior across proxy types](/proxies/overview).
1212

@@ -19,7 +19,7 @@ For some organizations, Kernel attaches a backup ISP endpoint from a different p
1919
Create an ISP proxy with an exit IP in Singapore:
2020

2121
<Info>
22-
ISP proxies support country targeting in the United States (`US`), Singapore (`SG`), the United Kingdom (`GB`), France (`FR`), and Germany (`DE`). If you omit `country`, the proxy defaults to `US`.
22+
ISP proxies support country targeting in the United States (`US`), Singapore (`SG`), the United Kingdom (`GB`), France (`FR`), and Germany (`DE`). If you omit `country`, the proxy defaults to `US` unless you set a reserved `ip_address`, in which case it uses that IP's country.
2323
</Info>
2424

2525
<CodeGroup>
@@ -96,7 +96,8 @@ func main() {
9696

9797
## Configuration parameters
9898

99-
- **`country`** (optional) - ISO 3166 country code. Supported values are `US`, `SG`, `GB`, `FR`, and `DE`. Defaults to `US`.
99+
- **`country`** (optional) - ISO 3166 country code. Supported values are `US`, `SG`, `GB`, `FR`, and `DE`. Defaults to `US`, or to the country of `ip_address` when you set one.
100+
- **`ip_address`** (optional) - An active IP from your organization's reserved ISP allocation. Set it to pin the proxy to that exit IP; if you also set `country`, they must match. Omit it to let Kernel choose an IP.
100101
- **`bypass_hosts`** (optional) - Array of hostnames that bypass the proxy and connect directly (max 100 entries)
101102

102103
## .gov support
@@ -176,7 +177,7 @@ See the [overview](/proxies/overview#bypass-hosts) for full bypass host rules an
176177

177178
## Getting the static IP address
178179

179-
Because an ISP proxy has a static exit IP, you can read that IP once and reuse it — for example, to add it to an IP allowlist. The IP is returned as `ip_address` in the response when you [create a proxy](https://kernel.sh/docs/api-reference/proxies/create-a-proxy) and when you [get a proxy by ID](https://kernel.sh/docs/api-reference/proxies/get-proxy-by-id).
180+
Because an ISP proxy has a static exit IP, you can read that IP once and reuse it while the proxy remains on that IP — for example, to add it to an IP allowlist. The IP is returned as `ip_address` in the response when you [create a proxy](https://kernel.sh/docs/api-reference/proxies/create-a-proxy) and when you [get a proxy by ID](https://kernel.sh/docs/api-reference/proxies/get-proxy-by-id). If you move the proxy to another reserved IP, update any allowlists that use the old address.
180181

181182
<CodeGroup>
182183
```typescript Typescript/Javascript

‎proxies/overview.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Kernel-provided proxies are unmetered and not billed, subject to the fair use ru
2121
</Note>
2222

2323
<Info>
24-
ISP proxies provide a **static exit IP that persists across sessions** — every browser session attached to the proxy exits through the same IP, and it only changes in rare ISP-initiated replacement events or a temporary [failover to a backup endpoint](/proxies/isp#backup-endpoint-failover). This makes them suitable for IP allowlists or [managed auth](/auth/managed-auth) health checks that must egress from a single IP.
24+
ISP proxies provide a **static exit IP that persists across sessions** — every browser session attached to the proxy exits through the same IP. The primary IP stays fixed unless you move a proxy backed by a reserved ISP allocation or an ISP initiates a replacement; traffic can temporarily use a different IP during a [failover to a backup endpoint](/proxies/isp#backup-endpoint-failover). This makes ISP proxies suitable for IP allowlists or [managed auth](/auth/managed-auth) health checks that must egress from a single IP.
2525

2626
Residential and mobile proxy exit IPs may change per connection — see [Residential routing and IP behavior](/proxies/residential#routing-and-ip-behavior) and [Mobile Proxies](/proxies/mobile) for details.
2727
</Info>

0 commit comments

Comments
 (0)