Update a proxy

PUT

/api/v1/proxies/{proxy_id}

Fully replace the name, notes, and connection settings of a custom or api proxy, then return its updated full details. mode must match the existing proxy. For API proxies, auth_type defaults to whitelist. Both username and password are required when credential is selected; whitelist ignores and clears credentials. Omitting remark, username, or password clears that field. integ and syt proxies are managed by the platform and cannot be updated through this endpoint. The update does not change the most recent check status, check time, or profile bindings.

Request parameters

Authorization Bearer Token

Include your API Key as a Bearer token in the Authorization request header.

Authorization: Bearer <api-key>

Path parameters

Fields

stringrequired

Unique proxy ID

Example"proxy_01JABCDEF1234567890"

minLength: 1

Body parameters

requiredapplication/jsonProxyUpdateRequest

Fields

object

Generated from the schema; not a live response.

{
  "name": "string",
  "mode": "custom",
  "config": {
    "protocol": "http",
    "ip_protocol": "ipv4",
    "host": "string",
    "port": 0
  }
}

Request code examples

JavaScript / TypeScript: Node.js 18+ with fetch; PHP: cURL extension; Go: 1.16+; Java: JDK 11+. Replace the token and example parameter values before running.

curl -X PUT -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' -d '{
  "name": "string",
  "mode": "custom",
  "config": {
    "protocol": "http",
    "ip_protocol": "ipv4",
    "host": "string",
    "port": 0
  }
}' 'http://local.zhongyibrowser.com:39025/api/v1/proxies/proxy_01JABCDEF1234567890'

fetch("http://local.zhongyibrowser.com:39025/api/v1/proxies/proxy_01JABCDEF1234567890", {
  method: "PUT",
  headers: {
      "Authorization": "Bearer <TOKEN>",
      "Content-Type": "application/json"
    },
  body: "{\n  \"name\": \"string\",\n  \"mode\": \"custom\",\n  \"config\": {\n    \"protocol\": \"http\",\n    \"ip_protocol\": \"ipv4\",\n    \"host\": \"string\",\n    \"port\": 0\n  }\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

async function main(): Promise<void> {
  const options: RequestInit = {
    "method": "PUT",
    "headers": {
      "Authorization": "Bearer <TOKEN>",
      "Content-Type": "application/json"
    },
    "body": "{\n  \"name\": \"string\",\n  \"mode\": \"custom\",\n  \"config\": {\n    \"protocol\": \"http\",\n    \"ip_protocol\": \"ipv4\",\n    \"host\": \"string\",\n    \"port\": 0\n  }\n}"
  }
  const response: Response = await fetch("http://local.zhongyibrowser.com:39025/api/v1/proxies/proxy_01JABCDEF1234567890", options)
  const data: unknown = await response.json()
  console.log(data)
}

main().catch(console.error)

<?php
$ch = curl_init('http://local.zhongyibrowser.com:39025/api/v1/proxies/proxy_01JABCDEF1234567890');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <TOKEN>',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => '{
  "name": "string",
  "mode": "custom",
  "config": {
    "protocol": "http",
    "ip_protocol": "ipv4",
    "host": "string",
    "port": 0
  }
}',
]);

$response = curl_exec($ch);
if ($response === false) {
  throw new RuntimeException(curl_error($ch));
}
curl_close($ch);
echo $response . PHP_EOL;

package main

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

func main() {
	req, err := http.NewRequest("PUT", "http://local.zhongyibrowser.com:39025/api/v1/proxies/proxy_01JABCDEF1234567890", strings.NewReader(`{
  "name": "string",
  "mode": "custom",
  "config": {
    "protocol": "http",
    "ip_protocol": "ipv4",
    "host": "string",
    "port": 0
  }
}`))
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("Authorization", "Bearer <TOKEN>")
	req.Header.Set("Content-Type", "application/json")

	response, err := http.DefaultClient.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer response.Body.Close()

	data, err := io.ReadAll(response.Body)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
  public static void main(String[] args) throws Exception {
    String body = "{\n" +
        "  \"name\": \"string\",\n" +
        "  \"mode\": \"custom\",\n" +
        "  \"config\": {\n" +
        "    \"protocol\": \"http\",\n" +
        "    \"ip_protocol\": \"ipv4\",\n" +
        "    \"host\": \"string\",\n" +
        "    \"port\": 0\n" +
        "  }\n" +
        "}";
    HttpClient client = HttpClient.newHttpClient();
    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("http://local.zhongyibrowser.com:39025/api/v1/proxies/proxy_01JABCDEF1234567890"))
        .header("Authorization", "Bearer <TOKEN>")
        .header("Content-Type", "application/json")
        .method("PUT", HttpRequest.BodyPublishers.ofString(body))
        .build();

    HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  }
}

import requests

url = "http://local.zhongyibrowser.com:39025/api/v1/proxies/proxy_01JABCDEF1234567890"
headers = {
    "Authorization": "Bearer <TOKEN>",
    "Content-Type": "application/json"
}
data = "{\n  \"name\": \"string\",\n  \"mode\": \"custom\",\n  \"config\": {\n    \"protocol\": \"http\",\n    \"ip_protocol\": \"ipv4\",\n    \"host\": \"string\",\n    \"port\": 0\n  }\n}"

response = requests.put(url, headers=headers, data=data)
print(response.json())

Responses

Success: code = 0. Failure: code > 0. Select a status to view its fields and example. Expand objects to inspect nested fields. Optional fields may be omitted.

Updated proxy details

Body

application/jsonProxyDetailSuccessResponse

Fields

numberrequired

Business status code; always 0 on success

Enum

stringrequired

Business status message; always success on success

Enum

objectrequired

Endpoint business data

Generated from the schema; not a live response.

{
  "code": 0,
  "message": "success",
  "data": {
    "id": "string",
    "name": "string",
    "remark": "string",
    "status": "unchecked",
    "checked_at": "2024-01-15T09:30:00Z",
    "browser_count": 0,
    "is_expired": true,
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z",
    "mode": "custom",
    "config": {
      "protocol": "http",
      "ip_protocol": "ipv4",
      "host": "string",
      "port": 0,
      "username": "string",
      "password": "string"
    },
    "browser_ids": [
      "env_01JABCDEF1234567890"
    ]
  }
}

View all business error codes and HTTP statuses

Update a proxy ​

Request parameters

Request code examples

Responses

Update a proxy