KEkernel
Proxies

List proxies

Changed on

List proxies in the resolved project.

get/proxies

Request

  • Base URL
    https://api.onkernel.com
  • URL
    https://api.onkernel.com/proxies
  • Auth
    HTTP bearer

Query parameters

limitinteger

Limit the number of proxies to return.

offsetinteger

Offset the number of proxies to return.

querystring

Case-insensitive substring match against proxy name, host, or IP address. IDs match by exact value.

namestring

Exact-match filter on proxy name using the database collation. In production, matching is case- and accent-insensitive. Names are not required to be unique, so multiple proxies may match.

Response

List of proxies

bypass_hostsstring[]

Hostnames that should bypass the parent proxy and connect directly.

idstring
ip_addressstring

IP address that the proxy uses when making requests.

last_checkedstring date-time

Timestamp of the last health check performed on this proxy.

namestring

Readable name of the proxy.

protocol'http' | 'https'

Protocol to use for the proxy connection.

status'available' | 'unavailable'

Current health status 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 is deprecated; use isp instead. Existing datacenter proxies remain supported.

Example response

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

Changes

  • 03b369edee49Revision changes
    • info

      response property items/config/oneOf[subschema #1: Datacenter]/ deprecated

  • 6cfc6a03c923Revision changes
    • info

      added the optional property /// to the response with the status