GET
/
zones
/
{zone_id}
/
proxies

Authorizations

X-API-KEY
string
headerrequired

Path Parameters

zone_id
string
required

The ID of the zone to retrieve proxy credentials for.

Maximum length: 8

Query Parameters

format
enum<string>

The format of the returned proxy credentials.

When format=json the Content-Type of the response is application/json and the proxies array in the result is an array of JSON objects with username, password, host, port and protocol properties.

When format=csv the Content-Type of the response is text/csv and the body of the response is the proxy connection details in CSV format.

For all other values of format the Content-Type of the response is application/json and the proxies array in the response is an array of strings containing the connection details in the requested format.

Available options:
user:pass@host:port,
user:pass:host:port,
host:port:user:pass,
host,port,user,pass,
json,
csv
protocol
enum<string>

The protocol of the returned proxy credentials. If none is chosen then the protocol prefix is not shown on the proxy host and the port defaults to the HTTP port (8080).

Available options:
http,
https,
none
type
enum<string>

The type of the returned proxy credentials. multiple_sessions will return the number of proxy credentials specified in the session_count parameter (with a new session ID for each) - not valid on a zone set up on the datacenter network with ip_type=reserved. proxy_per_country will return a proxy credential for each country available on the zone network. random_country will return a single proxy credential that will choose a random country per-request. proxy_per_ip will return proxy credentials for each of the IPs in a reserved datacenter zones` IP pool.

Available options:
proxy_per_ip,
multiple_sessions,
proxy_per_country,
random_country
session_count
integer
default: 10

When type=multiple_sessions the session_count parameter defines the number of proxy credentials, each with a different session ID, that are generated.

Required range: 1 < x < 10000
country
string

An ISO 3166 two-letter country code to use for the generated proxy credentials. Only valid when type=multiple_sessions.

Response

200 - application/json
status
enum<string>
Available options:
ok
proxies
string[]

An array of strings containing the requested proxy credentials, formatted as-per the format request parameter.

When format=json the Content-Type of the response is application/json and the proxies array in the result is an array of JSON objects with username, password, host, port and protocol properties.

When format=csv the Content-Type of the response is text/csv and the body of the response is the proxy connection details in CSV format.

For all other values of format the Content-Type of the response is application/json and the proxies array in the response is an array of strings containing the connection details in the requested format.

Delete zone IPsSearch users