Generate connection strings

Builds connection strings without changing the service. Only use targeting and session options present in the service capabilities. Copy the returned line into your proxy client; credentials in the output are secret.

post/v1/services/{id}/endpoints

Request

  • Base URL: https://api.trueproxies.com
  • URL: https://api.trueproxies.com/v1/services/{id}/endpoints
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Query parameters

customer_idstring uuid

Owned sub-customer UUID. Resellers only; reads require reseller:read and writes reseller:purchase in addition to the operation scope. X-Customer-Id header is an alternative. Not allowed for me, wallet, trial, API keys, or reseller-management routes.

Request body

asnstring

1 to 10 digits, without AS prefix. Requires asn capability.

citystring

Letters, digits and underscores; normalized to lowercase. Requires city capability.

countinteger

Number of connection strings. Omission, null and legacy zero values use one.

countrystring

Two-letter country code; normalized to lowercase. Requires country capability.

format'host:port:user:pass' | 'user:pass@host:port' | 'user:pass' | 'host:port' | 'url' | 'curl' | 'custom'
job_idstring uuid

Owned active job beneath project_id. Only its validated opaque token is included in generated proxy usernames.

lifetimeinteger

Sticky session lifetime in seconds, 60 to 86400, or 1 to 86400 when the service has session_lifetime_seconds. Maximum is 1800 with session_lifetime_30m. Requires session=sticky and session_lifetime capability. Residential IPv4 Unlimited requires whole minutes. Omitted or zero leaves the lifetime unset.

project_idstring uuid

Owned, active project access. Omit to use main access. Requires current project support.

protocol'http' | 'socks5' | 'https'
regionstring

Requires region capability. Services with region_code accept only an ISO 3166-2 subdivision code of 1 to 3 letters or digits without country prefix (for example CA). Other services accept letters, digits and underscores up to 32 characters. Normalized to lowercase in customer usernames.

session'none' | 'sticky' | 'rotate' | 'port'

port gives each line its own gateway port (SOCKS5 10000-10999, HTTP 20000-20999), and each port keeps one sticky IP for 24 hours (30 minutes with session_lifetime_30m) while that IP stays available. Requires port_sessions capability and protocol http or socks5; lifetime is not accepted.

templatestring

Required only for format=custom. A single line of literal text, limited to 512 UTF-8 bytes, with at least one of {HOST}, {PORT}, {USER}, {PASS} or {PROTOCOL}. Other braces and control characters are rejected. Placeholder values are substituted literally without escaping or recursive expansion. {PROTOCOL} is the connection URL scheme (http, https or socks5h).

Response

ok

linesstring[] required

Changes

No recorded changes to this operation across all 1 revision of this API.