Sign in

v97

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-31135175384.2 KB
Proxies

Rename proxy by ID

Update a proxy's name. Proxy names are not unique and are not ID-or-name addressable on this endpoint; duplicate names are allowed. Name-based session-create lookups can remain ambiguous until callers resolve proxies by ID or the API adds a stronger uniqueness contract.

patch/proxies/{id}

Path parameters

idstring required

Request body

namestring required

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

Example request

{
  "name": "my-renamed-proxy"
}

Response

Proxy updated

idstring
namestring

Readable name 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.

protocol'http' | 'https'

Protocol to use for the proxy connection.

bypass_hostsstring[]

Hostnames that should bypass the parent proxy and connect directly.

status'available' | 'unavailable'

Current health status of the proxy.

last_checkedstring date-time

Timestamp of the last health check performed on this proxy.

ip_addressstring

IP address that the proxy uses when making requests.

Example response

{
  "ip_address": "192.168.1.1",
  "config": {
    "country": "US"
  }
}