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

proxyIdstringRequiredformat: "uuid"

Headers

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.

Request

This endpoint expects an object.
autoRenewbooleanOptional
citystringOptional1-120 characters
countrystringOptional=2 characters
deviceenumOptional
dnsResolutionenumOptional
geoIdstringOptional1-200 characters
hoststringOptional
ipFamilyenumOptional
ispstringOptional1-120 characters
namestringOptional1-100 characters
passwordstring or nullOptional
poolenumOptional
portintegerOptional<=65535
preferenceenumOptional
protocolenumOptional
regionstringOptional1-120 characters
rotationenumOptional
statestringOptional1-120 characters
stickyKeystringOptional1-200 characters
udpModeenumOptional
urlstringOptional1-4096 characters
usernamestring or nullOptional

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