Update a proxy
Renames the proxy identified by the path ID.
Authorizations
Bearer token via Authorization header
Path Parameters
Body
New display name, up to 64 characters excluding surrounding whitespace, and containing no NUL. Send null (or an empty/whitespace-only string) to drop a custom name and go back to the generated label. Omit to leave the name unchanged.
Response
The updated proxy.
A provisioned proxy without its credentials.
ISO 3166-1 alpha-2 country code (lowercase).
Display name for the proxy. Set it on create or change it with PATCH; when no name has been set, a label generated from the proxy's country, type, and id is returned instead — so this is never empty.
"🇩🇪 Germany · Dedicated residential · 769fc289"
Lifecycle of a proxy. A freshly created proxy is checking while its billing identity is being resolved — clients should poll until a paymentUrl or a later status appears — then provisioning — or pending_payment until the customer completes checkout — and becomes active once its upstream is assigned. cancelling retains full access through the paid period; when the subscription expires the proxy is ended. error marks a failed provisioning attempt.
checking, pending_payment, provisioning, active, cancelling, ended, error dedicated_residential, residential, mobile included, standalone_paid