Create Proxy Test Run
curl --request POST \
--url https://api.example.com/public/user/proxy_test_run/create \
--header 'Content-Type: application/json' \
--header 'X-API-Private-Key: <api-key>' \
--header 'X-API-Public-Key: <api-key>' \
--data '
{
"proxies": [
{
"proxy_id": "8ca1bf7f-7e8e-490e-ad0a-715e5eb060a6",
"proxy_string": "209.99.134.6:5702:ftrdddgq:518vrc41xyms"
}
],
"proxy_tester_server_id": [
"london-2-digitalocean-proxytester-1"
],
"urls": [
"https://google.com"
]
}
'import requests
url = "https://api.example.com/public/user/proxy_test_run/create"
payload = {
"proxies": [
{
"proxy_id": "8ca1bf7f-7e8e-490e-ad0a-715e5eb060a6",
"proxy_string": "209.99.134.6:5702:ftrdddgq:518vrc41xyms"
}
],
"proxy_tester_server_id": ["london-2-digitalocean-proxytester-1"],
"urls": ["https://google.com"]
}
headers = {
"X-API-Private-Key": "<api-key>",
"X-API-Public-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-API-Private-Key': '<api-key>',
'X-API-Public-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
proxies: [
{
proxy_id: '8ca1bf7f-7e8e-490e-ad0a-715e5eb060a6',
proxy_string: '209.99.134.6:5702:ftrdddgq:518vrc41xyms'
}
],
proxy_tester_server_id: ['london-2-digitalocean-proxytester-1'],
urls: ['https://google.com']
})
};
fetch('https://api.example.com/public/user/proxy_test_run/create', 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.example.com/public/user/proxy_test_run/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'proxies' => [
[
'proxy_id' => '8ca1bf7f-7e8e-490e-ad0a-715e5eb060a6',
'proxy_string' => '209.99.134.6:5702:ftrdddgq:518vrc41xyms'
]
],
'proxy_tester_server_id' => [
'london-2-digitalocean-proxytester-1'
],
'urls' => [
'https://google.com'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Private-Key: <api-key>",
"X-API-Public-Key: <api-key>"
],
]);
$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.example.com/public/user/proxy_test_run/create"
payload := strings.NewReader("{\n \"proxies\": [\n {\n \"proxy_id\": \"8ca1bf7f-7e8e-490e-ad0a-715e5eb060a6\",\n \"proxy_string\": \"209.99.134.6:5702:ftrdddgq:518vrc41xyms\"\n }\n ],\n \"proxy_tester_server_id\": [\n \"london-2-digitalocean-proxytester-1\"\n ],\n \"urls\": [\n \"https://google.com\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Private-Key", "<api-key>")
req.Header.Add("X-API-Public-Key", "<api-key>")
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.post("https://api.example.com/public/user/proxy_test_run/create")
.header("X-API-Private-Key", "<api-key>")
.header("X-API-Public-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"proxies\": [\n {\n \"proxy_id\": \"8ca1bf7f-7e8e-490e-ad0a-715e5eb060a6\",\n \"proxy_string\": \"209.99.134.6:5702:ftrdddgq:518vrc41xyms\"\n }\n ],\n \"proxy_tester_server_id\": [\n \"london-2-digitalocean-proxytester-1\"\n ],\n \"urls\": [\n \"https://google.com\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/public/user/proxy_test_run/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Private-Key"] = '<api-key>'
request["X-API-Public-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"proxies\": [\n {\n \"proxy_id\": \"8ca1bf7f-7e8e-490e-ad0a-715e5eb060a6\",\n \"proxy_string\": \"209.99.134.6:5702:ftrdddgq:518vrc41xyms\"\n }\n ],\n \"proxy_tester_server_id\": [\n \"london-2-digitalocean-proxytester-1\"\n ],\n \"urls\": [\n \"https://google.com\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"created": [
"5b1494e7-663f-4af6-adf8-67ec8b18cf66"
],
"data": {
"db8cd8d3-bc99-4880-9a1d-233af9a35eda": {
"results": [
{
"proxy_test_result_id": "38c1c64b-af29-4e3d-93f2-4c1a1a313ac5",
"proxy_test_run_id": "5b1494e7-663f-4af6-adf8-67ec8b18cf66",
"proxy_tester_proxy_id": "db8cd8d3-bc99-4880-9a1d-233af9a35eda",
"proxy_test_result_url": "https://google.com",
"proxy_test_result_is_successful": false,
"proxy_test_result_error_code": "bad_request",
"proxy_test_result_error_source": "target",
"proxy_test_result_protocol": "http",
"proxy_test_result_response_time": 224,
"proxy_test_server_id": "london-2-digitalocean-proxytester-1",
"proxy_test_server_city_id": 383210,
"proxy_test_server_city_name": "London",
"proxy_test_server_country_id": "gb",
"proxy_test_result_creation_datetime": "2025-01-24 09:34:56",
"proxy_test_result_last_update_datetime": "2025-01-24 09:34:56",
"proxy_username": "ftrdddgq",
"proxy_host": "148.135.178.94",
"proxy_port": 5655,
"proxy_ip_address": "148.135.178.94",
"proxy_country_id": "fr",
"proxy_city_id": 379657,
"proxy_city_name": "Paris",
"proxy_asn_id": 29802,
"proxy_asn_name": "AS29802 HIVELOCITY, Inc."
}
]
}
},
"message": "Successfully returned proxy test run",
"proxy_test_result_created": [
"38c1c64b-af29-4e3d-93f2-4c1a1a313ac5"
],
"proxy_tester_proxy_created": [
"db8cd8d3-bc99-4880-9a1d-233af9a35eda"
]
}Proxy Tester
Create Proxy Test Run
Test all provided proxies against urls
POST
/
public
/
user
/
proxy_test_run
/
create
Create Proxy Test Run
curl --request POST \
--url https://api.example.com/public/user/proxy_test_run/create \
--header 'Content-Type: application/json' \
--header 'X-API-Private-Key: <api-key>' \
--header 'X-API-Public-Key: <api-key>' \
--data '
{
"proxies": [
{
"proxy_id": "8ca1bf7f-7e8e-490e-ad0a-715e5eb060a6",
"proxy_string": "209.99.134.6:5702:ftrdddgq:518vrc41xyms"
}
],
"proxy_tester_server_id": [
"london-2-digitalocean-proxytester-1"
],
"urls": [
"https://google.com"
]
}
'import requests
url = "https://api.example.com/public/user/proxy_test_run/create"
payload = {
"proxies": [
{
"proxy_id": "8ca1bf7f-7e8e-490e-ad0a-715e5eb060a6",
"proxy_string": "209.99.134.6:5702:ftrdddgq:518vrc41xyms"
}
],
"proxy_tester_server_id": ["london-2-digitalocean-proxytester-1"],
"urls": ["https://google.com"]
}
headers = {
"X-API-Private-Key": "<api-key>",
"X-API-Public-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-API-Private-Key': '<api-key>',
'X-API-Public-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
proxies: [
{
proxy_id: '8ca1bf7f-7e8e-490e-ad0a-715e5eb060a6',
proxy_string: '209.99.134.6:5702:ftrdddgq:518vrc41xyms'
}
],
proxy_tester_server_id: ['london-2-digitalocean-proxytester-1'],
urls: ['https://google.com']
})
};
fetch('https://api.example.com/public/user/proxy_test_run/create', 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.example.com/public/user/proxy_test_run/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'proxies' => [
[
'proxy_id' => '8ca1bf7f-7e8e-490e-ad0a-715e5eb060a6',
'proxy_string' => '209.99.134.6:5702:ftrdddgq:518vrc41xyms'
]
],
'proxy_tester_server_id' => [
'london-2-digitalocean-proxytester-1'
],
'urls' => [
'https://google.com'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Private-Key: <api-key>",
"X-API-Public-Key: <api-key>"
],
]);
$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.example.com/public/user/proxy_test_run/create"
payload := strings.NewReader("{\n \"proxies\": [\n {\n \"proxy_id\": \"8ca1bf7f-7e8e-490e-ad0a-715e5eb060a6\",\n \"proxy_string\": \"209.99.134.6:5702:ftrdddgq:518vrc41xyms\"\n }\n ],\n \"proxy_tester_server_id\": [\n \"london-2-digitalocean-proxytester-1\"\n ],\n \"urls\": [\n \"https://google.com\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Private-Key", "<api-key>")
req.Header.Add("X-API-Public-Key", "<api-key>")
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.post("https://api.example.com/public/user/proxy_test_run/create")
.header("X-API-Private-Key", "<api-key>")
.header("X-API-Public-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"proxies\": [\n {\n \"proxy_id\": \"8ca1bf7f-7e8e-490e-ad0a-715e5eb060a6\",\n \"proxy_string\": \"209.99.134.6:5702:ftrdddgq:518vrc41xyms\"\n }\n ],\n \"proxy_tester_server_id\": [\n \"london-2-digitalocean-proxytester-1\"\n ],\n \"urls\": [\n \"https://google.com\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/public/user/proxy_test_run/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Private-Key"] = '<api-key>'
request["X-API-Public-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"proxies\": [\n {\n \"proxy_id\": \"8ca1bf7f-7e8e-490e-ad0a-715e5eb060a6\",\n \"proxy_string\": \"209.99.134.6:5702:ftrdddgq:518vrc41xyms\"\n }\n ],\n \"proxy_tester_server_id\": [\n \"london-2-digitalocean-proxytester-1\"\n ],\n \"urls\": [\n \"https://google.com\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"created": [
"5b1494e7-663f-4af6-adf8-67ec8b18cf66"
],
"data": {
"db8cd8d3-bc99-4880-9a1d-233af9a35eda": {
"results": [
{
"proxy_test_result_id": "38c1c64b-af29-4e3d-93f2-4c1a1a313ac5",
"proxy_test_run_id": "5b1494e7-663f-4af6-adf8-67ec8b18cf66",
"proxy_tester_proxy_id": "db8cd8d3-bc99-4880-9a1d-233af9a35eda",
"proxy_test_result_url": "https://google.com",
"proxy_test_result_is_successful": false,
"proxy_test_result_error_code": "bad_request",
"proxy_test_result_error_source": "target",
"proxy_test_result_protocol": "http",
"proxy_test_result_response_time": 224,
"proxy_test_server_id": "london-2-digitalocean-proxytester-1",
"proxy_test_server_city_id": 383210,
"proxy_test_server_city_name": "London",
"proxy_test_server_country_id": "gb",
"proxy_test_result_creation_datetime": "2025-01-24 09:34:56",
"proxy_test_result_last_update_datetime": "2025-01-24 09:34:56",
"proxy_username": "ftrdddgq",
"proxy_host": "148.135.178.94",
"proxy_port": 5655,
"proxy_ip_address": "148.135.178.94",
"proxy_country_id": "fr",
"proxy_city_id": 379657,
"proxy_city_name": "Paris",
"proxy_asn_id": 29802,
"proxy_asn_name": "AS29802 HIVELOCITY, Inc."
}
]
}
},
"message": "Successfully returned proxy test run",
"proxy_test_result_created": [
"38c1c64b-af29-4e3d-93f2-4c1a1a313ac5"
],
"proxy_tester_proxy_created": [
"db8cd8d3-bc99-4880-9a1d-233af9a35eda"
]
}Authorizations
Private API key for user-level authentication.
Public API key for user-level authentication.
Body
application/json
Proxy Test Run Request
The proxies to be tested
Maximum array length:
20Show child attributes
Show child attributes
Example:
[
{
"proxy_id": "8ca1bf7f-7e8e-490e-ad0a-715e5eb060a6",
"proxy_string": "209.99.134.6:5702:ftrdddgq:518vrc41xyms"
}
]
ID of the server to test the proxy on (optional - all will be used if not provided)
Example:
["london-2-digitalocean-proxytester-1"]
URLs to test the proxy against
Example:
["https://google.com"]
Response
200 - application/json
Successful proxy test creation
ID of the proxy test run object that was created
Example:
["5b1494e7-663f-4af6-adf8-67ec8b18cf66"]
Show child attributes
Show child attributes
Example:
{
"db8cd8d3-bc99-4880-9a1d-233af9a35eda": {
"results": [
{
"proxy_test_result_id": "38c1c64b-af29-4e3d-93f2-4c1a1a313ac5",
"proxy_test_run_id": "5b1494e7-663f-4af6-adf8-67ec8b18cf66",
"proxy_tester_proxy_id": "db8cd8d3-bc99-4880-9a1d-233af9a35eda",
"proxy_test_result_url": "https://google.com",
"proxy_test_result_is_successful": false,
"proxy_test_result_error_code": "bad_request",
"proxy_test_result_error_source": "target",
"proxy_test_result_protocol": "http",
"proxy_test_result_response_time": 224,
"proxy_test_server_id": "london-2-digitalocean-proxytester-1",
"proxy_test_server_city_id": 383210,
"proxy_test_server_city_name": "London",
"proxy_test_server_country_id": "gb",
"proxy_test_result_creation_datetime": "2025-01-24 09:34:56",
"proxy_test_result_last_update_datetime": "2025-01-24 09:34:56",
"proxy_username": "ftrdddgq",
"proxy_host": "148.135.178.94",
"proxy_port": 5655,
"proxy_ip_address": "148.135.178.94",
"proxy_country_id": "fr",
"proxy_city_id": 379657,
"proxy_city_name": "Paris",
"proxy_asn_id": 29802,
"proxy_asn_name": "AS29802 HIVELOCITY, Inc."
}
]
}
}
Response message from the API
Example:
"Successfully returned proxy test run"
IDs of the test result objects that were created
Example:
["38c1c64b-af29-4e3d-93f2-4c1a1a313ac5"]
IDs of the proxy tester proxy objects that were created
Example:
["db8cd8d3-bc99-4880-9a1d-233af9a35eda"]
⌘I

