Document proxy health check in proxies overview#437
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
There was a problem hiding this comment.
Stale comment
Risk assessment: Very Low
I assessed the actual diff only. This PR adds a short documentation section and examples to
proxies/overview.mdxwith no production code, configuration, navigation, infrastructure, prompt, auth, billing, permission, or schema changes. I also found no CODEOWNERS file in the workspace, so there wasn't an ownership-review blocker visible from the repository contents.GitHub already reports this PR as approved, so I’m leaving the risk assessment without adding another approval.
Sent by Cursor Automation: Assign PR reviewers
There was a problem hiding this comment.
Risk assessment: Very Low
I assessed the actual diff only. This PR adds 24 lines to proxies/overview.mdx: a new documentation section describing proxy health checks, plus TypeScript/JavaScript, Python, and Go examples and an informational note. It doesn't modify production code, shared libraries, navigation/configuration, infrastructure, prompts/model instructions, auth, billing, permissions, or schema behavior.
I found no CODEOWNERS file in the repository checkout, so there wasn't an ownership-review blocker visible from the repo contents. GitHub already reports this PR as approved, and the PR is already merged, so I’m leaving this assessment as a comment without adding another approval.
Sent by Cursor Automation: Assign PR reviewers
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 3ea269b096
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| </CodeGroup> | ||
|
|
||
| <Info> | ||
| For ISP and datacenter proxies the exit IP is stable, so a successful check against a `url` reliably indicates that subsequent sessions will reach the same target from the same IP. For residential and mobile proxies the exit node changes between requests, so the check validates credentials and connectivity but not site-specific reachability. When `url` is provided, the result does not update the proxy's stored health status. |
There was a problem hiding this comment.
Align datacenter IP rotation guidance
This sentence says datacenter proxies have a stable exit IP and that follow-up sessions will use the same IP, but the existing proxy overview above and proxies/datacenter.mdx both state datacenter proxies rotate per request and recommend ISP/custom for stable IPs. Users checking a target URL for IP allowlists or managed-auth flows will get contradictory guidance and may pick datacenter expecting stability; either update the existing rotation docs if behavior changed or remove datacenter from this claim.
Useful? React with 👍 / 👎.


Summary
Adds a "Check proxy health" section to the proxies overview page with guidance on when to run a health check (after creation, after rotating credentials, when a session starts failing) and code samples in TS/Python/Go.
The examples include the optional
urlparameter to test reachability against a specific target, and an Info callout explains the ISP/datacenter vs residential/mobile nuance and the fact that passingurldoes not update the proxy's stored health status.Test plan
Note
Low Risk
Documentation-only MDX change with no runtime or API behavior changes.
Overview
Adds a Check proxy health section to
proxies/overview.mdx, placed after Use with browsers and before Bypass hosts.The section documents running
proxies.checkbefore attaching a proxy to a session, with optionalurlto test a specific target instead of Kernel defaults. It includes TypeScript, Python, and Go samples and an Info callout on ISP/datacenter (stable exit IP vs URL reachability) vs residential/mobile (rotating exits), plus that supplyingurldoes not update the proxy's stored health status.Reviewed by Cursor Bugbot for commit 3ea269b. Bugbot is set up for automated code reviews on this repo. Configure here.