Skip to main content
POST
/
proxies
/
{id}
/
check
JavaScript
import Kernel from '@onkernel/sdk';

const client = new Kernel({
  apiKey: process.env['KERNEL_API_KEY'], // This is the default and can be omitted
});

const response = await client.proxies.check('id');

console.log(response.id);
{
  "type": "datacenter",
  "country": "US",
  "id": "<string>",
  "name": "<string>",
  "protocol": "https",
  "bypass_hosts": [
    "<string>"
  ],
  "status": "available",
  "last_checked": "2023-11-07T05:31:56Z",
  "ip_address": "192.168.1.1",
  "config": {
    "country": "US"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json

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.

Response

Health check completed

Configuration for routing traffic through a proxy.

​
type
enum<string>
required

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

Available options:
datacenter,
isp,
residential,
mobile,
custom
​
country
string

ISO 3166 country code. Defaults to US if not provided.

Example:

"US"

​
id
string
​
name
string

Readable name of the proxy.

​
protocol
enum<string>
default:https

Protocol to use for the proxy connection.

Available options:
http,
https
​
bypass_hosts
string[]

Hostnames that should bypass the parent proxy and connect directly.

​
status
enum<string>

Current health status of the proxy.

Available options:
available,
unavailable
​
last_checked
string<date-time>

Timestamp of the last health check performed on this proxy.

​
ip_address
string

IP address that the proxy uses when making requests.

Example:

"192.168.1.1"

​
config
object

Configuration specific to the selected proxy type.