GET
/
zones

Authorizations

X-API-KEY
string
headerrequired

Query Parameters

search
string

The search query string to use to search the Zone name (not case sensitive).

Maximum length: 100
enabled
boolean

Set to true to return only enabled Zones, false to return only disabled Zones, or omit to return all.

network
enum<string>

Filter the Zones returned to those on the datacenter, mobile or residential proxy networks. Separate multiple values with a comma.

Available options:
datacenter,
mobile,
residential
billing_method
enum<string>

Filter the Zones returned to those using per_gigabyte or per_connection billing methods. Separate multiple values with a comma.

Available options:
per_gigabyte,
per_connection
page
integer
default: 1

The page of results to return.

Required range: 1 < x < 1000
count
integer
default: 10

The number of Zones to return per-page between 1 and 100. The default is 10.

Required range: 1 < x < 100
sort_by
enum<string>

Sort the returned Zones returned by name or network.

Available options:
name,
network
sort_order
enum<string>

Determines the sort order of the returned Zones. Valid values are ascending or descending. Defaults to descending.

Available options:
ascending,
descending

Response

200 - application/json
status
enum<string>
Available options:
ok
info
object
pagination
object
zones
object[]