Sign in

v97

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-31135175384.2 KB
Proxies

Check proxy health

Run a health check on the proxy to verify it's working. Optionally specify a URL to test reachability against a specific target. For ISP and datacenter proxies, this reliably tests whether the target site is reachable from the proxy's stable exit IP. For residential and mobile proxies, the exit node varies between requests, so this validates proxy configuration and connectivity rather than guaranteeing site-specific reachability.

post/proxies/{id}/check

Path parameters

idstring required

Request body

urlstring

An optional URL to test reachability against. If provided, the proxy check will test connectivity to this URL instead of the default test URLs. Only HTTP and HTTPS schemes are allowed, and the URL must resolve to a public IP address. For ISP and datacenter proxies, the exit IP is stable, so a successful check reliably indicates that subsequent browser sessions will reach the target site with the same IP. For residential and mobile proxies, the exit node changes between requests, so a successful check validates proxy configuration but does not guarantee that a subsequent browser session will use the same exit IP or reach the same site — it is useful for verifying credentials and connectivity, not for predicting site-specific behavior. When provided, the check result does not update the proxy's health status, since a failure may indicate a problem with the target site rather than the proxy itself.

Example request

{
  "url": "https://example.com"
}

Response

Health check completed

idstring
namestring

Readable name of the proxy.

type'datacenter' | 'isp' | 'residential' | 'mobile' | 'custom' required

Proxy type to use. In terms of quality for avoiding bot-detection, from best to worst: mobile > residential > isp > datacenter.

protocol'http' | 'https'

Protocol to use for the proxy connection.

bypass_hostsstring[]

Hostnames that should bypass the parent proxy and connect directly.

status'available' | 'unavailable'

Current health status of the proxy.

last_checkedstring date-time

Timestamp of the last health check performed on this proxy.

ip_addressstring

IP address that the proxy uses when making requests.

Example response

{
  "ip_address": "192.168.1.1",
  "config": {
    "country": "US"
  }
}