Skip to navigation
API ReferenceProxies

Update a Proxy

View as Markdown
Update one saved proxy. Future browser runtimes can use the updated proxy configuration.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

proxyIdstringRequired

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.
BCTRL-Subaccount-IdstringOptional
Optional effective subaccount context for organization API keys. Subaccount API keys are already scoped and cannot use this header to act as another subaccount.
Idempotency-KeystringOptional1-200 characters

Optional retry key for this billable operation. Reusing the same key with the same request replays its stable outcome; credential-bearing results may be freshly issued for the same principal. Reusing it with a different request returns 409.

Request

This endpoint expects an object.
autoRenewbooleanOptional
citystringOptional1-120 characters
countrystringOptional=2 characters
deviceenumOptional
Allowed values:
dnsResolutionenumOptional
Allowed values:
geoIdstringOptional1-200 characters
hoststringOptional
ipFamilyenumOptional
Allowed values:
ispstringOptional1-120 characters
namestringOptional1-200 characters

Customer-facing resource name. 1–200 characters.

passwordstring or nullOptional
poolenumOptional
Allowed values:
portintegerOptional<=65535
preferenceenumOptional
Allowed values:
protocolenumOptional
Allowed values:
regionstringOptional1-120 characters
rotationenumOptional
Allowed values:
statestringOptional1-120 characters
stickyKeystringOptional1-200 characters
udpModeenumOptional
Allowed values:
urlstringOptional1-4096 characters
usernamestring or nullOptional

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
ProxyCustomobject
OR
ProxyManagedRotatingany
OR
ManagedStaticProxyobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error