Skip to navigation
API ReferenceProxies

Get a Proxy Pool

View as Markdown
Get one managed proxy pool by id before creating a managed static proxy.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

poolIdstringRequired

Headers

BCTRL-VersionenumOptional
Dated API version. Defaults to the release pinned when the API key was created.
Allowed values:
BCTRL-SpacestringOptional
Select one authorized Space by its opaque ID or unique name. Omission uses the operation default.

Response headers

BCTRL-Request-IdstringOptional
Current request identifier, also echoed in errors.
BCTRL-VersionstringOptional
Negotiated dated API version.
RateLimit-Limitinteger

Evaluated policy limit; zero when no finite policy was evaluated.

RateLimit-Remaininginteger

Remaining policy budget; zero when no finite policy was evaluated.

RateLimit-Resetinteger

Seconds until reset; zero when no finite policy was evaluated.

Response

OK
availableCountinteger>=0
categoryenum
countrystring=2 characters
idstring
labelstring
object"proxy_pool"
priceCreditsinteger>=0
termDaysinteger
citystringOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error