Connect Proxies

Returns the proxy identified by the path ID. The response includes the proxy's password.

get/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

Response

The proxy, including its password.

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
passwordstring required
paymentUrlstring nullable

Checkout URL to complete payment while status is pending_payment. Null once paid or when no payment was required.

Example response

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

Changes

    • breaking

      added the new path request parameter id

    • warning

      added the new checking enum value to the //// response property for the response status

    • info

      api operation id GetProxy removed and replaced with GetConnectProxy

    • info

      the endpoint scheme security OwnerIDHeader AND UserIDHeader was removed from the API

    • info

      the endpoint scheme security UserIDHeader was removed from the API

    • info

      api tag Connect Proxies added

    • info

      api tag Proxies removed

    • info

      added the optional property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      the response's property default value dedicated_residential was removed for the status