Generate proxy credentials

POST

/proxies/generate

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.proxyrequest.com/api/v1/proxies/generate");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Accept-Language: de");
headers = curl_slist_append(headers, "Authorization: Bearer <token>");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{ \"package_id\": \"550e8400-e29b-41d4-a716-446655440002\", \"quantity\": 2, \"targeting\": { \"country\": \"us\", \"region\": \"california\", \"city\": \"los_angeles\", \"isp\": \"comcast\" }, \"connection\": { \"protocol\": \"http\", \"format\": \"{host}:{port}:{username}:{password}\" }, \"session\": { \"ttl\": 60 } }");

CURLcode ret = curl_easy_perform(hnd);

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://api.proxyrequest.com/api/v1/proxies/generate"),
    Headers =
    {
        { "Accept-Language", "de" },
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"package_id\": \"550e8400-e29b-41d4-a716-446655440002\", \"quantity\": 2, \"targeting\": { \"country\": \"us\", \"region\": \"california\", \"city\": \"los_angeles\", \"isp\": \"comcast\" }, \"connection\": { \"protocol\": \"http\", \"format\": \"{host}:{port}:{username}:{password}\" }, \"session\": { \"ttl\": 60 } }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

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

func main() {

  url := "https://api.proxyrequest.com/api/v1/proxies/generate"

  payload := strings.NewReader("{ \"package_id\": \"550e8400-e29b-41d4-a716-446655440002\", \"quantity\": 2, \"targeting\": { \"country\": \"us\", \"region\": \"california\", \"city\": \"los_angeles\", \"isp\": \"comcast\" }, \"connection\": { \"protocol\": \"http\", \"format\": \"{host}:{port}:{username}:{password}\" }, \"session\": { \"ttl\": 60 } }")

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

  req.Header.Add("Accept-Language", "de")
  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(res)
  fmt.Println(string(body))

}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.proxyrequest.com/api/v1/proxies/generate"))
    .header("Accept-Language", "de")
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{ \"package_id\": \"550e8400-e29b-41d4-a716-446655440002\", \"quantity\": 2, \"targeting\": { \"country\": \"us\", \"region\": \"california\", \"city\": \"los_angeles\", \"isp\": \"comcast\" }, \"connection\": { \"protocol\": \"http\", \"format\": \"{host}:{port}:{username}:{password}\" }, \"session\": { \"ttl\": 60 } }"))
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{ \"package_id\": \"550e8400-e29b-41d4-a716-446655440002\", \"quantity\": 2, \"targeting\": { \"country\": \"us\", \"region\": \"california\", \"city\": \"los_angeles\", \"isp\": \"comcast\" }, \"connection\": { \"protocol\": \"http\", \"format\": \"{host}:{port}:{username}:{password}\" }, \"session\": { \"ttl\": 60 } }");
Request request = new Request.Builder()
  .url("https://api.proxyrequest.com/api/v1/proxies/generate")
  .post(body)
  .addHeader("Accept-Language", "de")
  .addHeader("Authorization", "Bearer <token>")
  .addHeader("Content-Type", "application/json")
  .build();

Response response = client.newCall(request).execute();

import axios from 'axios';

const options = {
  method: 'POST',
  url: 'https://api.proxyrequest.com/api/v1/proxies/generate',
  headers: {
    'Accept-Language': 'de',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  data: {
    package_id: '550e8400-e29b-41d4-a716-446655440002',
    quantity: 2,
    targeting: {country: 'us', region: 'california', city: 'los_angeles', isp: 'comcast'},
    connection: {protocol: 'http', format: '{host}:{port}:{username}:{password}'},
    session: {ttl: 60}
  }
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

const url = 'https://api.proxyrequest.com/api/v1/proxies/generate';
const options = {
  method: 'POST',
  headers: {
    'Accept-Language': 'de',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"package_id":"550e8400-e29b-41d4-a716-446655440002","quantity":2,"targeting":{"country":"us","region":"california","city":"los_angeles","isp":"comcast"},"connection":{"protocol":"http","format":"{host}:{port}:{username}:{password}"},"session":{"ttl":60}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

val client = OkHttpClient()

val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{ \"package_id\": \"550e8400-e29b-41d4-a716-446655440002\", \"quantity\": 2, \"targeting\": { \"country\": \"us\", \"region\": \"california\", \"city\": \"los_angeles\", \"isp\": \"comcast\" }, \"connection\": { \"protocol\": \"http\", \"format\": \"{host}:{port}:{username}:{password}\" }, \"session\": { \"ttl\": 60 } }")
val request = Request.Builder()
  .url("https://api.proxyrequest.com/api/v1/proxies/generate")
  .post(body)
  .addHeader("Accept-Language", "de")
  .addHeader("Authorization", "Bearer <token>")
  .addHeader("Content-Type", "application/json")
  .build()

val response = client.newCall(request).execute()

use serde_json::json;
use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "https://api.proxyrequest.com/api/v1/proxies/generate";

    let payload = json!({
        "package_id": "550e8400-e29b-41d4-a716-446655440002",
        "quantity": 2,
        "targeting": json!({
            "country": "us",
            "region": "california",
            "city": "los_angeles",
            "isp": "comcast"
        }),
        "connection": json!({
            "protocol": "http",
            "format": "{host}:{port}:{username}:{password}"
        }),
        "session": json!({"ttl": 60})
    });

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("Accept-Language", "de".parse().unwrap());
    headers.insert("Authorization", "Bearer <token>".parse().unwrap());
    headers.insert("Content-Type", "application/json".parse().unwrap());

    let client = reqwest::Client::new();
    let response = client.post(url)
        .headers(headers)
        .json(&payload)
        .send()
        .await;

    let results = response.unwrap()
        .json::<serde_json::Value>()
        .await
        .unwrap();

    dbg!(results);
}

curl --request POST \
  --url https://api.proxyrequest.com/api/v1/proxies/generate \
  --header 'Accept-Language: de' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "package_id": "550e8400-e29b-41d4-a716-446655440002", "quantity": 2, "targeting": { "country": "us", "region": "california", "city": "los_angeles", "isp": "comcast" }, "connection": { "protocol": "http", "format": "{host}:{port}:{username}:{password}" }, "session": { "ttl": 60 } }'

wget --quiet \
  --method POST \
  --header 'Accept-Language: de' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --body-data '{ "package_id": "550e8400-e29b-41d4-a716-446655440002", "quantity": 2, "targeting": { "country": "us", "region": "california", "city": "los_angeles", "isp": "comcast" }, "connection": { "protocol": "http", "format": "{host}:{port}:{username}:{password}" }, "session": { "ttl": 60 } }' \
  --output-document \
  - https://api.proxyrequest.com/api/v1/proxies/generate

Creates ready-to-use proxy credentials for a purchased package. Use targeting to choose a location or provider scope, connection to choose protocol and output format, and session to control sticky session lifetime. Omit connection.host to choose one random eligible gateway for the entire request. The default port comes from that gateway’s cluster. Targeting location does not select the entry gateway’s region. Explicit host and port remain supported for custom endpoints.

Authorizations

BearerAuth
StaticAuth

Parameters

Header Parameters

Accept-Language

string

default: en

Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Examples

de

fr-CA, fr;q=0.9, en;q=0.5

Request Body^required

Validates proxy generation request data and builds generator config.

object

package_id

required

ProxyRequest package UUID used to generate credentials. Headless integrations must resolve this from their local product mapping.

string format: uuid

user_id

ProxyRequest sub-user UUID that will use the generated credentials. Resolve it from your local customer mapping. Must be the caller’s own sub-user, even for superusers. Omit to generate for the authenticated account. For an independent top-level customer, authenticate as that customer rather than sending its ID with a global key.

string format: uuid

quantity

required

Number of proxies to generate

integer

>= 1 <= 5000

targeting

object

continent

Target continent code.

string

<= 255 characters

country

Target country code.

string

<= 255 characters

region

Target region or state code.

string

<= 255 characters

city

Target city code.

string

<= 255 characters

pool

Proxy pool identifier.

string

<= 255 characters

asn

Target autonomous system number.

integer

<= 65536

isp

Target internet service provider.

string

<= 255 characters

Target operating system: linux, windows, ios, macos, android. Use comma-separated values only when combined OS targeting is enabled.

string

<= 255 characters

connection

object

protocol

Proxy protocol. * http - http * socks5 - socks5 * auto - auto

string

Allowed values: http socks5 auto

host

Gateway host. Leave empty to choose one available gateway for the entire request.

string

<= 255 characters

port

Gateway port. Leave empty to use the port for the selected protocol.

integer

>= 1 <= 65535

format

Connection string format.

string

default: {protocol}://{username}:{password}@{host}:{port} >= 1 characters

session

object

ttl

Sticky session lifetime in seconds. The accepted range is configured per deployment.

integer

default: 600 >= 1 <= 86400

Examples

GenerateHTTPProxiesForACountry

Generate HTTP proxies for a country

{
  "package_id": "550e8400-e29b-41d4-a716-446655440002",
  "quantity": 2,
  "targeting": {
    "country": "us",
    "region": "california",
    "city": "los_angeles",
    "isp": "comcast"
  },
  "connection": {
    "protocol": "http",
    "format": "{host}:{port}:{username}:{password}"
  },
  "session": {
    "ttl": 60
  }
}

Validates proxy generation request data and builds generator config.

object

package_id

required

ProxyRequest package UUID used to generate credentials. Headless integrations must resolve this from their local product mapping.

string format: uuid

user_id

string format: uuid

quantity

required

Number of proxies to generate

integer

>= 1 <= 5000

targeting

object

continent

Target continent code.

string

<= 255 characters

country

Target country code.

string

<= 255 characters

region

Target region or state code.

string

<= 255 characters

city

Target city code.

string

<= 255 characters

pool

Proxy pool identifier.

string

<= 255 characters

asn

Target autonomous system number.

integer

<= 65536

isp

Target internet service provider.

string

<= 255 characters

Target operating system: linux, windows, ios, macos, android. Use comma-separated values only when combined OS targeting is enabled.

string

<= 255 characters

connection

object

protocol

Proxy protocol. * http - http * socks5 - socks5 * auto - auto

string

Allowed values: http socks5 auto

host

Gateway host. Leave empty to choose one available gateway for the entire request.

string

<= 255 characters

port

Gateway port. Leave empty to use the port for the selected protocol.

integer

>= 1 <= 65535

format

Connection string format.

string

default: {protocol}://{username}:{password}@{host}:{port} >= 1 characters

session

object

ttl

Sticky session lifetime in seconds. The accepted range is configured per deployment.

integer

default: 600 >= 1 <= 86400

Examples

GenerateHTTPProxiesForACountry

Generate HTTP proxies for a country

package_id=550e8400-e29b-41d4-a716-446655440002&quantity=2&country=us&region=california&city=los_angeles&isp=comcast&protocol=http&format=%7Bhost%7D%3A%7Bport%7D%3A%7Busername%7D%3A%7Bpassword%7D&ttl=60

Validates proxy generation request data and builds generator config.

object

package_id

required

ProxyRequest package UUID used to generate credentials. Headless integrations must resolve this from their local product mapping.

string format: uuid

user_id

string format: uuid

quantity

required

Number of proxies to generate

integer

>= 1 <= 5000

targeting

object

continent

Target continent code.

string

<= 255 characters

country

Target country code.

string

<= 255 characters

region

Target region or state code.

string

<= 255 characters

city

Target city code.

string

<= 255 characters

pool

Proxy pool identifier.

string

<= 255 characters

asn

Target autonomous system number.

integer

<= 65536

isp

Target internet service provider.

string

<= 255 characters

Target operating system: linux, windows, ios, macos, android. Use comma-separated values only when combined OS targeting is enabled.

string

<= 255 characters

connection

object

protocol

Proxy protocol. * http - http * socks5 - socks5 * auto - auto

string

Allowed values: http socks5 auto

host

Gateway host. Leave empty to choose one available gateway for the entire request.

string

<= 255 characters

port

Gateway port. Leave empty to use the port for the selected protocol.

integer

>= 1 <= 65535

format

Connection string format.

string

default: {protocol}://{username}:{password}@{host}:{port} >= 1 characters

session

object

ttl

Sticky session lifetime in seconds. The accepted range is configured per deployment.

integer

default: 600 >= 1 <= 86400

Examples

GenerateHTTPProxiesForACountry

Generate HTTP proxies for a country

{
  "package_id": "550e8400-e29b-41d4-a716-446655440002",
  "quantity": 2,
  "targeting": {
    "country": "us",
    "region": "california",
    "city": "los_angeles",
    "isp": "comcast"
  },
  "connection": {
    "protocol": "http",
    "format": "{host}:{port}:{username}:{password}"
  },
  "session": {
    "ttl": 60
  }
}

Responses

201

The resource or action result was created successfully.

application/json

object

count

required

integer

proxies

required

Array<object>

object

host

required

string

port

required

integer

protocol

required

string

username

required

string

password

required

string

connection_string

required

string

Examples

GeneratedProxyCredentials

Generated proxy credentials

{
  "count": 2,
  "proxies": [
    {
      "host": "proxy.thepremiumports.com",
      "port": 8000,
      "protocol": "http",
      "username": "pkg-res-country-us-region-california",
      "password": "proxy-password",
      "connection_string": "proxy.thepremiumports.com:8000:pkg-res-country-us-region-california:proxy-password"
    }
  ]
}

400

The request is malformed or violates a business rule.

application/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object

detail

string

non_field_errors

Array<string>

key

additional properties

One of:

string
Array<string>

string

Examples

ValidationError

Validation error

{
  "non_field_errors": [
    "The request could not be processed."
  ]
}

Headers

Content-Language

string

Language used for human-readable errors.

401

Authentication credentials are missing, expired, or invalid.

application/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object

detail

string

non_field_errors

Array<string>

key

additional properties

One of:

string
Array<string>

string

Examples

AuthenticationRequired

Authentication required

{
  "detail": "Authentication credentials were not provided."
}

Headers

Content-Language

string

Language used for human-readable errors.

403

The authenticated account cannot perform this operation.

application/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object

detail

string

non_field_errors

Array<string>

key

additional properties

One of:

string
Array<string>

string

Examples

PermissionDenied

Permission denied

{
  "detail": "You do not have permission to perform this action."
}

Headers

Content-Language

string

Language used for human-readable errors.

404

The requested resource does not exist in the current account scope.

application/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object

detail

string

non_field_errors

Array<string>

key

additional properties

One of:

string
Array<string>

string

Examples

ResourceNotFound

Resource not found

{
  "detail": "Not found."
}

Headers

Content-Language

string

Language used for human-readable errors.

Generate proxy credentials

Authorizations

Parameters

Header Parameters

Examples

Request Bodyrequired

Examples

Examples

Examples

Responses

201

Examples

400

Examples

Headers

401

Examples

Headers

403

Examples

Headers

404

Examples

Headers

Request Body^required