Skip to main content
GET
/
proxies
/
{id}
Get proxy by ID
curl --request GET \
  --url https://api.onkernel.com/proxies/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "protocol": "https",
  "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

Response

Proxy retrieved

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
​
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
​
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.