Check a temporary proxy

Client version1.8.0 (latest)1.7.0Version overview

POST

Example base URLhttp://local.zhongyibrowser.com:39025http://127.0.0.1:39025/api/v1/proxies/check

Check the temporary custom or api proxy settings in the request body without creating a proxy or updating any saved proxy. In api mode, the extraction URL is requested first to resolve the current IPv4 address and port. When auth_type=credential, username/password are used to check the connection; whitelist uses the existing allowlist behavior. Connection failures and timeouts are normal check results: status is unavailable in an HTTP 200 response. This endpoint requires only a Local API Key and does not depend on the client backend login session.

Request parameters

Authorization Bearer Token

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

Authorization: Bearer <api-key>

Body parameters

requiredRequest content typeapplication/jsonProxyCheckRequest

Fields

›object

Example

Generated from the schema; not a live response.

{
  "mode": "custom",
  "config": {
    "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 POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' -d '{
  "mode": "custom",
  "config": {
    "host": "string",
    "port": 0
  }
}' 'http://local.zhongyibrowser.com:39025/api/v1/proxies/check'

fetch("http://local.zhongyibrowser.com:39025/api/v1/proxies/check", {
  method: "POST",
  headers: {
      "Authorization": "Bearer <TOKEN>",
      "Content-Type": "application/json"
    },
  body: "{\n  \"mode\": \"custom\",\n  \"config\": {\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": "POST",
    "headers": {
      "Authorization": "Bearer <TOKEN>",
      "Content-Type": "application/json"
    },
    "body": "{\n  \"mode\": \"custom\",\n  \"config\": {\n    \"host\": \"string\",\n    \"port\": 0\n  }\n}"
  }
  const response: Response = await fetch("http://local.zhongyibrowser.com:39025/api/v1/proxies/check", 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/check');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <TOKEN>',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => '{
  "mode": "custom",
  "config": {
    "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("POST", "http://local.zhongyibrowser.com:39025/api/v1/proxies/check", strings.NewReader(`{
  "mode": "custom",
  "config": {
    "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" +
        "  \"mode\": \"custom\",\n" +
        "  \"config\": {\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/check"))
        .header("Authorization", "Bearer <TOKEN>")
        .header("Content-Type", "application/json")
        .method("POST", 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/check"
headers = {
    "Authorization": "Bearer <TOKEN>",
    "Content-Type": "application/json"
}
data = "{\n  \"mode\": \"custom\",\n  \"config\": {\n    \"host\": \"string\",\n    \"port\": 0\n  }\n}"

response = requests.post(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.

Temporary proxy check result

Body

Response content typeapplication/jsonProxyCheckSuccessResponse

Fields

›numberrequired

Business status code; always 0 on success

Enum

›stringrequired

Business status message; always success on success

Enum

›objectrequired

Endpoint business data

Additional fields are not allowed.

Example

Generated from the schema; not a live response.

{
  "code": 0,
  "message": "success",
  "data": {
    "mode": "custom",
    "status": "available",
    "endpoint": {
      "protocol": "http",
      "ip_protocol": "ipv4",
      "host": "string",
      "port": 0
    },
    "checked_at": "2024-01-15T09:30:00Z",
    "latency_ms": 0
  }
}

View all business error codes and HTTP statuses