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

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Optional parameters for the proxy health check.

url?string

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.

Response

application/json

Health check completed

Configuration for routing traffic through a proxy.

id?string

name?string

Readable name of the proxy.

type*string

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

Value in

"datacenter"
"isp"
"residential"
"mobile"
"custom"

protocol?string

Protocol to use for the proxy connection.

Default"https"

Value in

"http"
"https"

bypass_hosts?array<string>

Hostnames that should bypass the parent proxy and connect directly.

status?string

Current health status of the proxy.

Value in

"available"
"unavailable"

last_checked?string

Timestamp of the last health check performed on this proxy.

Formatdate-time

ip_address?string

IP address that the proxy uses when making requests.

config?||||

Configuration specific to the selected proxy type.

curl -X POST "https://example.com/proxies/string/check" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "name": "string",  "type": "datacenter",  "protocol": "http",  "bypass_hosts": [    "string"  ],  "status": "available",  "last_checked": "2019-08-24T14:15:22Z",  "ip_address": "string",  "config": {    "country": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}