KEkernel
Proxies

Get proxy by ID or name

Retrieve a proxy in the resolved project by ID or exact name using the database collation. IDs take precedence when a value matches both an ID and a name. Proxy names are not unique; an ambiguous name returns a 400 response with code ambiguous_proxy_name.

get/proxies/{id_or_name}

Request

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

Path parameters

id_or_namestring required

Response

Proxy retrieved

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

No recorded changes to this operation across all 123 revisions of this API.