Rename proxy by ID

curl --request PATCH \
  --url https://api.onkernel.com/proxies/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "my-renamed-proxy"
}
'

import requests

url = "https://api.onkernel.com/proxies/{id}"

payload = { "name": "my-renamed-proxy" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'my-renamed-proxy'})
};

fetch('https://api.onkernel.com/proxies/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.onkernel.com/proxies/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'my-renamed-proxy'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.onkernel.com/proxies/{id}"

	payload := strings.NewReader("{\n  \"name\": \"my-renamed-proxy\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.onkernel.com/proxies/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"my-renamed-proxy\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onkernel.com/proxies/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"my-renamed-proxy\"\n}"

response = http.request(request)
puts response.read_body

{
  "host": "127.0.0.1",
  "port": 8080,
  "has_ca_bundle": true,
  "has_password": true,
  "username": "user123",
  "bypass_hosts": [
    "<string>"
  ],
  "config": {
    "country": "US"
  },
  "id": "<string>",
  "ip_address": "192.168.1.1",
  "last_checked": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "protocol": "https"
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

PATCH

proxies

{id}

Rename proxy by ID

curl --request PATCH \
  --url https://api.onkernel.com/proxies/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "my-renamed-proxy"
}
'

import requests

url = "https://api.onkernel.com/proxies/{id}"

payload = { "name": "my-renamed-proxy" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'my-renamed-proxy'})
};

fetch('https://api.onkernel.com/proxies/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.onkernel.com/proxies/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'my-renamed-proxy'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.onkernel.com/proxies/{id}"

	payload := strings.NewReader("{\n  \"name\": \"my-renamed-proxy\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.onkernel.com/proxies/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"my-renamed-proxy\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onkernel.com/proxies/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"my-renamed-proxy\"\n}"

response = http.request(request)
puts response.read_body

{
  "host": "127.0.0.1",
  "port": 8080,
  "has_ca_bundle": true,
  "has_password": true,
  "username": "user123",
  "bypass_hosts": [
    "<string>"
  ],
  "config": {
    "country": "US"
  },
  "id": "<string>",
  "ip_address": "192.168.1.1",
  "last_checked": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "protocol": "https"
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Body

application/json

name

string

required

New proxy name. Proxy names are trimmed and length-checked only; duplicates are allowed because proxies are updated by ID, not by name.

Required string length: 1 - 255

Example:

"my-renamed-proxy"

Response

Proxy updated

Custom
Datacenter
ISP
Mobile
Residential

Configuration for routing traffic through a proxy.

host

string

required

Proxy host address or IP.

Example:

"127.0.0.1"

port

integer

required

Proxy port.

Example:

8080

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

has_ca_bundle

boolean

Whether the proxy has a custom CA bundle configured.

Example:

true

has_password

boolean

Whether the proxy has a password.

Example:

true

username

string

Username for proxy authentication.

Example:

"user123"

bypass_hosts

string[]

Hostnames that should bypass the parent proxy and connect directly.

config

Datacenter · object

Configuration specific to the selected proxy type.

Datacenter
ISP
Residential
Mobile
Custom

Show child attributes

string

ip_address

string

IP address that the proxy uses when making requests.

Example:

"192.168.1.1"

last_checked

string<date-time>

Timestamp of the last health check performed on this proxy.

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

⌘I

Apps

Audit Logs

Managed Auth

Authentication

Browser Pools

Browsers

Browser Computer Controls

Browser Filesystem

Browser Logs

Browser Playwright

Browser Processes

Browser Replays

Browser Telemetry

Deployments

Extensions

Invocations

API Keys

Organization

Projects

Profiles

Proxies

Rename proxy by ID

Authorizations

Path Parameters

Body

Response