Skip to main content
POST
/
proxies
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 proxy = await client.proxies.create({ type: 'datacenter' });

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

Authorizations

​
Authorization
string
header
required

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

Body

application/json

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
​
name
string

Readable name of the proxy.

​
protocol
enum<string>
default:https

Protocol to use for the proxy connection.

Available options:
http,
https
​
config
object

Configuration specific to the selected proxy type.

Response

Proxy created successfully

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.

​
config
object

Configuration specific to the selected proxy type.