KEkernel
Proxies

Create a proxy

Changed on

Create a new proxy configuration in the resolved project.

post/proxies

Request

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

Request body

bypass_hostsstring[]

Hostnames that should bypass the parent proxy and connect directly.

namestring

Readable name of the proxy.

protocol'http' | 'https'

Protocol to use for the proxy connection.

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. Datacenter proxy creation remains supported for backward compatibility.

Example request

{
  "config": {
    "country": "US"
  }
}

Response

Proxy created successfully

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

      request property / deprecated

    • info

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

  • 9e8ce9fcf5e1Revision changes
    • warning

      the // request property's maxLength was set to 4096