Sign in

v1

latestOpenAPI 3.0.32026-07-2246176.0 KB
Datacenter

Get datacenter proxy list

Get the datacenter proxy list for a subaccount. Filter by country, protocol, format, and status. Permission: datacenter_shared:read or datacenter_dedicated:read.

get/v4/account/{subAccountId}/datacenter_shared/proxy-list

Path parameters

subAccountIdstring uuid required

Query parameters

type'getproxies' | 'displayproxies'

Controls download behaviour. getproxies (default) sends a Content-Disposition: attachment header so the browser treats the response as a file download, and stamps last_downloaded on the account. displayproxies returns the same list inline with no download header and no timestamp update.

country[]string[]

Filter proxies by ISO 3166-1 alpha-2 country code (e.g. us, de). Pass multiple values to include proxies from any of those countries. Pass all (or include all in the array) to skip country filtering and return proxies from all countries.

protocol'http' | 'socks' required
format'json' | 'data' | 'credentials'

Output format. Omit for default plain text (one host:port per line). json returns a structured object with a data array, totals, and draw counter. data returns a country breakdown with counts but no proxy IPs. credentials returns credential-formatted lines using the account's proxy username and password — requires proxy_credentials_enabled on the account, returns 403 if not enabled.

proxy_format'ipport' | 'protocolipport'

Controls how the proxy address is formatted in the output. ipport (default) returns bare host:port. protocolipport prepends the scheme: http://host:port or socks5://host:port. Has no effect when format=credentials — that mode always strips any prefix and derives the scheme from the protocol parameter.

credential_format1 | 2 | 3

Line format for credential-based output. Only applies when format=credentials; silently ignored for all other format values. 1 → host:port:username:password. 2 (default) → username:password@host:port. 3 → http://username:password@host:port or socks5://username:password@host:port (scheme derived from the protocol parameter).

status'online' | 'offline'

Filter proxies by availability. online returns only currently reachable proxies. offline returns only unreachable proxies. Omit to return all proxies regardless of status.

startinteger

Zero-based offset into the filtered result set. Default is 0.

limitinteger

Maximum number of proxies to return. Can also be passed as length (alias). Applied after all other filters.

lengthinteger

Alias for limit.

drawinteger

Arbitrary integer echoed back unchanged in the draw field of format=json responses. Used by DataTables to correlate requests with responses. Has no effect on other format values.

Response

Success. Response content-type and shape depend on the format parameter.

OR

Example response

{
  "data": [
    [
      "1.2.3.4:3129",
      "HTTP",
      "Online",
      "us"
    ]
  ]
}