DRdroidrun
Connect Proxies

Create a proxy

Changed on

Provisions a proxy of the requested type for the caller in the selected country.

post/connect/proxies

Request

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

Headers

Idempotency-Keystring

Optional idempotency key, unique per owner (1-128 characters after trimming; surrounding whitespace is ignored). Reusing a key returns the originally created proxy with its original credentials, regardless of changed request parameters.

Request body

countrystring country-code required

ISO 3166-1 alpha-2 country code to provision the proxy in.

namestring

Display name for the proxy, up to 64 characters excluding surrounding whitespace, and containing no NUL. Omit it (or send only whitespace) to get a generated label built from the country, type, and id.

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

Response

The created 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

  • 4ad548c528a8Revision changes
    • warning

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

    • info

      api operation id CreateProxy removed and replaced with CreateConnectProxy

    • 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 new optional header request parameter Idempotency-Key

    • info

      added the new optional request property

    • info

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

    • info

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

  • ae1fe0ca6359Revision changes
    • breaking

      the request property became required

    • info

      the request property default value dedicated_residential was removed

    • info

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