Connect Proxies

Renames the proxy identified by the path ID.

patch/connect/proxies/{id}

Request

  • Base URL
    https://api.mobilerun.ai
  • URL
    https://api.mobilerun.ai/connect/proxies/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

Request body

namestring nullable

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.

billingMode'included' | 'standalone_paid'
countrystring required

ISO 3166-1 alpha-2 country code (lowercase).

createdAtstring date-time required
hoststring required
idstring uuid required
namestring required

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.

portinteger required
status'checking' | 'pending_payment' | 'provisioning' | 'active' | 'cancelling' | 'ended' | 'error' required

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.

type'dedicated_residential' | 'residential' | 'mobile' required
usernamestring required

Example response

{
  "name": "🇩🇪 Germany · Dedicated residential · 769fc289"
}

Changes