Mobilerun Connect Proxies API
Manage your Mobilerun Connect Proxies
Manage your Mobilerun Connect Proxies
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/mobilerun-ai:mobilerun-ai-connect-proxies-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Mobilerun Ai Connect Proxies API
version: v1
contact:
name: Droidrun
email: support@droidrun.ai
description: 'Operations tagged Connect Proxies across 2 of this provider''s published API definitions: openapi.json, mobilerun-ai-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.mobilerun.ai
description: Droidrun Cloud API
security:
- bearerAuth: []
tags:
- description: Manage your Mobilerun Connect Proxies
name: Connect Proxies
x-group: Mobilerun Proxy
paths:
/connect/proxies:
get:
description: Returns proxies owned by the caller. Credentials are omitted from the list.
operationId: ListConnectProxies
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyList'
description: The caller's proxies, without credentials.
'401':
$ref: '#/components/responses/Unauthorized'
summary: List proxies
tags:
- Connect Proxies
parameters:
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PageSize'
- description: Filter to proxies in this country (ISO 3166-1 alpha-2, lowercase).
in: query
name: country
schema:
format: country-code
type: string
post:
description: Provisions a proxy of the requested type for the caller in the selected country.
operationId: CreateConnectProxy
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProxyRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyWithSecret'
description: The created proxy, including its password.
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'409':
$ref: '#/components/responses/Conflict'
summary: Create a proxy
tags:
- Connect Proxies
parameters:
- description: 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.
in: header
name: Idempotency-Key
schema:
type: string
servers:
- url: https://api.mobilerun.ai
description: Droidrun Cloud API
/connect/proxies/{id}:
delete:
description: Deletes the proxy identified by the path ID and releases its provisioning. Returns 404 if no such proxy exists for the caller.
operationId: DeleteConnectProxy
responses:
'204':
description: Proxy deleted.
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
summary: Delete a proxy
tags:
- Connect Proxies
parameters:
- $ref: '#/components/parameters/ProxyID'
get:
description: Returns the proxy identified by the path ID. The response includes the proxy's password.
operationId: GetConnectProxy
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyWithSecret'
description: The proxy, including its password.
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
summary: Get proxy by ID
tags:
- Connect Proxies
parameters:
- $ref: '#/components/parameters/ProxyID'
patch:
description: Renames the proxy identified by the path ID.
operationId: UpdateConnectProxy
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateProxyRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Proxy'
description: The updated proxy.
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
summary: Update a proxy
tags:
- Connect Proxies
parameters:
- $ref: '#/components/parameters/ProxyID'
servers:
- url: https://api.mobilerun.ai
description: Droidrun Cloud API
/connect/proxies/{id}/checkout:
post:
description: Refreshes a pending dedicated proxy's checkout on explicit payment intent. Already-paid proxies (provisioning, active, or cancelling) return their current status without a payment URL. An expired checkout requires a new purchase.
operationId: CheckoutConnectProxy
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyCheckout'
description: The current payment status and checkout URL, if unpaid.
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'409':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProxyCheckoutConflict'
description: The checkout expired or the proxy is no longer pending payment.
summary: Get a payable checkout for a pending proxy
tags:
- Connect Proxies
parameters:
- $ref: '#/components/parameters/ProxyID'
servers:
- url: https://api.mobilerun.ai
description: Droidrun Cloud API
/connect/proxies/{id}/connections:
get:
description: Returns the connection history recorded for this proxy, one item per connection (aggregated across the connection's lifetime). Supports filtering on every property plus ordering and pagination. Returns 503 when connection history is temporarily unavailable.
operationId: ListProxyConnections
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectionList'
description: A page of connections.
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'503':
$ref: '#/components/responses/ServiceUnavailable'
summary: List Proxy Connections
tags:
- Connect Proxies
parameters:
- $ref: '#/components/parameters/ProxyID'
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/ConnSessionId'
- $ref: '#/components/parameters/ConnUserId'
- $ref: '#/components/parameters/ConnDstHost'
- $ref: '#/components/parameters/ConnDstPort'
- $ref: '#/components/parameters/ConnProtocol'
- $ref: '#/components/parameters/ConnProvider'
- $ref: '#/components/parameters/ConnCountry'
- $ref: '#/components/parameters/ConnCloseReason'
- $ref: '#/components/parameters/ConnStatus'
- $ref: '#/components/parameters/ConnStartedAfter'
- $ref: '#/components/parameters/ConnStartedBefore'
- $ref: '#/components/parameters/ConnEndedAfter'
- $ref: '#/components/parameters/ConnEndedBefore'
- $ref: '#/components/parameters/ConnMinBytesIn'
- $ref: '#/components/parameters/ConnMaxBytesIn'
- $ref: '#/components/parameters/ConnMinBytesOut'
- $ref: '#/components/parameters/ConnMaxBytesOut'
- $ref: '#/components/parameters/ConnMinTotalBytes'
- $ref: '#/components/parameters/ConnMaxTotalBytes'
- $ref: '#/components/parameters/ConnMinDurationMs'
- $ref: '#/components/parameters/ConnMaxDurationMs'
- $ref: '#/components/parameters/ConnOrderBy'
- $ref: '#/components/parameters/ConnOrder'
servers:
- url: https://api.mobilerun.ai
description: Droidrun Cloud API
/connect/proxies/{id}/ensure-healthy:
post:
description: 'Checks right now that the proxy''s upstream accepts a connection through its current session. If the upstream refuses the session and the proxy is a rotating (sticky-session) proxy, the proxy is moved onto a fresh session that has been checked to work; its credentials and country stay the same, its exit IP changes. Intended for callers that are about to depend on the proxy (e.g. while provisioning a phone). After `rotated`, the gateway uses the new session within about 30 seconds. A `refused` or `unreachable` result is not an error: the response describes the proxy''s state.'
operationId: EnsureProxyHealthy
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyHealth'
description: The result of the check.
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/Conflict'
summary: Ensure the proxy's upstream session works
tags:
- Connect Proxies
parameters:
- $ref: '#/components/parameters/ProxyID'
servers:
- url: https://api.mobilerun.ai
description: Droidrun Cloud API
/connect/proxies/{id}/ping:
get:
description: Returns the most recent cached network-latency measurement for the proxy, sampled periodically by connecting through the proxy to a fixed target. `latency` is null when no measurement is available yet (e.g. the proxy is not active, or it has not been sampled since coming online).
operationId: PingProxy
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyLatency'
description: The proxy's latest latency reading.
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
summary: Latency check
tags:
- Connect Proxies
parameters:
- $ref: '#/components/parameters/ProxyID'
servers:
- url: https://api.mobilerun.ai
description: Droidrun Cloud API
components:
parameters:
ConnProvider:
description: Filter to connections served by this upstream provider identifier.
in: query
name: provider
schema:
type: string
ConnMinTotalBytes:
description: Filter to connections with at least this much total traffic (bytesIn + bytesOut).
in: query
name: minTotalBytes
schema:
format: int64
minimum: 0
type: integer
ConnOrder:
description: Sort direction.
in: query
name: order
schema:
default: desc
enum:
- asc
- desc
type: string
ConnMinDurationMs:
description: Filter to connections lasting at least this many milliseconds.
in: query
name: minDurationMs
schema:
format: int64
minimum: 0
type: integer
ConnMinBytesIn:
description: Filter to connections with at least this many bytes received from upstream.
in: query
name: minBytesIn
schema:
format: int64
minimum: 0
type: integer
ConnUserId:
description: Filter to connections made by this user.
in: query
name: userId
schema:
format: uuid
type: string
ConnStartedBefore:
description: Filter to connections that started at or before this time (inclusive).
in: query
name: startedBefore
schema:
format: date-time
type: string
ConnMaxDurationMs:
description: Filter to connections lasting at most this many milliseconds.
in: query
name: maxDurationMs
schema:
format: int64
minimum: 0
type: integer
ConnMinBytesOut:
description: Filter to connections with at least this many bytes sent to upstream.
in: query
name: minBytesOut
schema:
format: int64
minimum: 0
type: integer
ConnCloseReason:
description: Filter to connections that closed with this reason (closed connections only).
in: query
name: closeReason
schema:
type: string
ConnDstHost:
description: Filter to connections to this destination host (exact match).
in: query
name: dstHost
schema:
type: string
ConnDstPort:
description: Filter to connections to this destination port.
in: query
name: dstPort
schema:
maximum: 65535
minimum: 0
type: integer
PageSize:
description: Number of items per page.
in: query
name: pageSize
schema:
default: 20
maximum: 100
minimum: 1
type: integer
ConnMaxBytesOut:
description: Filter to connections with at most this many bytes sent to upstream.
in: query
name: maxBytesOut
schema:
format: int64
minimum: 0
type: integer
ConnProtocol:
description: Filter to connections of this transport protocol.
in: query
name: protocol
schema:
$ref: '#/components/schemas/ConnectionProtocol'
ConnSessionId:
description: Filter to a single connection by its session id.
in: query
name: sessionId
schema:
format: uuid
type: string
ConnCountry:
description: Filter to connections served from this upstream country (ISO 3166-1 alpha-2).
in: query
name: country
schema:
type: string
ConnOrderBy:
description: Property to order the results by.
in: query
name: orderBy
schema:
default: startedAt
enum:
- startedAt
- endedAt
- bytesIn
- bytesOut
- totalBytes
- durationMs
type: string
ProxyID:
in: path
name: id
required: true
schema:
format: uuid
type: string
ConnMaxBytesIn:
description: Filter to connections with at most this many bytes received from upstream.
in: query
name: maxBytesIn
schema:
format: int64
minimum: 0
type: integer
ConnMaxTotalBytes:
description: Filter to connections with at most this much total traffic (bytesIn + bytesOut).
in: query
name: maxTotalBytes
schema:
format: int64
minimum: 0
type: integer
ConnStatus:
description: Filter by connection status.
in: query
name: status
schema:
$ref: '#/components/schemas/ConnectionStatus'
Page:
description: Page number (1-based).
in: query
name: page
schema:
default: 1
minimum: 1
type: integer
ConnEndedAfter:
description: Filter to connections whose last activity was at or after this time (inclusive).
in: query
name: endedAfter
schema:
format: date-time
type: string
ConnStartedAfter:
description: Filter to connections that started at or after this time (inclusive).
in: query
name: startedAfter
schema:
format: date-time
type: string
ConnEndedBefore:
description: Filter to connections whose last activity was at or before this time (inclusive).
in: query
name: endedBefore
schema:
format: date-time
type: string
schemas:
Proxy:
description: A provisioned proxy without its credentials.
properties:
billingMode:
$ref: '#/components/schemas/ProxyBillingMode'
country:
description: ISO 3166-1 alpha-2 country code (lowercase).
type: string
createdAt:
format: date-time
type: string
host:
type: string
id:
format: uuid
type: string
name:
description: 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.
example: 🇩🇪 Germany · Dedicated residential · 769fc289
type: string
port:
format: int32
type: integer
status:
$ref: '#/components/schemas/ProxyStatus'
type:
$ref: '#/components/schemas/ProxyType'
username:
type: string
required:
- id
- name
- country
- type
- status
- host
- port
- username
- createdAt
type: object
ProxyList:
description: A page of proxies.
properties:
items:
items:
$ref: '#/components/schemas/Proxy'
type: array
pagination:
$ref: '#/components/schemas/ConnectPaginationMeta'
required:
- items
- pagination
type: object
ConnectionList:
description: A page of connections.
properties:
items:
items:
$ref: '#/components/schemas/Connection'
type: array
pagination:
$ref: '#/components/schemas/ConnectPaginationMeta'
required:
- items
- pagination
type: object
ProxyWithSecret:
allOf:
- $ref: '#/components/schemas/Proxy'
- properties:
password:
type: string
paymentUrl:
description: Checkout URL to complete payment while status is `pending_payment`. Null once paid or when no payment was required.
nullable: true
type: string
required:
- password
type: object
description: A proxy including its password. Returned only on create and single-proxy reads.
ConnectPaginationMeta:
description: Pagination metadata for a list response.
properties:
hasNext:
description: Whether a next page exists.
type: boolean
hasPrev:
description: Whether a previous page exists.
type: boolean
page:
description: Current page number (1-based).
type: integer
pageSize:
description: Number of items per page.
type: integer
pages:
description: Total number of pages.
type: integer
total:
description: Total number of items across all pages.
type: integer
required:
- page
- pageSize
- total
- pages
- hasNext
- hasPrev
type: object
ProxyCheckout:
properties:
paymentUrl:
description: Payable checkout URL; omitted after payment.
nullable: true
type: string
status:
$ref: '#/components/schemas/ProxyStatus'
required:
- status
type: object
ProxyType:
enum:
- dedicated_residential
- residential
- mobile
type: string
ProxyStatus:
description: 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.
enum:
- checking
- pending_payment
- provisioning
- active
- cancelling
- ended
- error
type: string
ProxyCheckoutConflict:
allOf:
- $ref: '#/components/schemas/ConnectErrorResponse'
- properties:
code:
enum:
- checkout_expired
- not_pending
type: string
required:
- code
type: object
ProxyLatency:
description: The latest cached latency reading for a proxy.
properties:
latency:
allOf:
- $ref: '#/components/schemas/LatencySample'
description: The latest reading, or null if none has been taken yet.
nullable: true
proxyId:
format: uuid
type: string
required:
- proxyId
- latency
type: object
UpdateProxyRequest:
properties:
name:
description: 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.
nullable: true
type: string
x-go-type: nullable.Nullable[string]
x-go-type-import:
path: github.com/oapi-codegen/nullable
x-go-type-skip-optional-pointer: true
type: object
ProxyHealth:
description: The outcome of an ensure-healthy check.
properties:
proxyId:
format: uuid
type: string
status:
description: '`healthy`: the upstream accepted the current session. `rotated`: the session was refused and the proxy now uses a fresh, checked session; retry through the proxy. `refused`: the session was refused and could not be replaced. `unreachable`: the upstream could not be reached; the session was left unchanged.'
enum:
- healthy
- rotated
- refused
- unreachable
type: string
required:
- proxyId
- status
type: object
ConnectionProtocol:
description: Transport protocol of a connection.
enum:
- tcp
- udp
- unknown
type: string
ConnectErrorResponse:
description: A Problem Details (RFC 7807-style) error response.
properties:
detail:
description: Human-readable explanation of this occurrence.
type: string
errors:
description: Per-input errors, when applicable.
items:
$ref: '#/components/schemas/ConnectErrorDetail'
type: array
status:
description: HTTP status code.
type: integer
title:
description: Short, human-readable summary of the error type.
type: string
required:
- title
- status
- detail
- errors
type: object
Connection:
description: A single proxy connection, aggregated across its lifetime. Byte counts are totals for the whole connection.
properties:
bytesIn:
description: Total bytes received from upstream over the connection's lifetime.
format: int64
type: integer
bytesOut:
description: Total bytes sent to upstream over the connection's lifetime.
format: int64
type: integer
closeReason:
description: Why the connection closed; null while still active.
nullable: true
type: string
country:
description: Upstream country code (ISO 3166-1 alpha-2), or empty if unknown.
type: string
dstHost:
description: Destination host the client connected to.
type: string
dstPort:
description: Destination port the client connected to.
type: integer
durationMs:
description: Elapsed time between startedAt and endedAt, in milliseconds.
format: int64
type: integer
endedAt:
description: Time of the connection's last recorded activity (close time once closed).
format: date-time
type: string
protocol:
$ref: '#/components/schemas/ConnectionProtocol'
provider:
description: Identifier of the upstream provider that served the connection.
type: string
proxyId:
description: The proxy the connection was routed through. All-zero when the upstream was unresolved at capture time.
format: uuid
type: string
sessionId:
description: Unique id of this connection.
format: uuid
type: string
srcIp:
description: Client source IP address.
type: string
startedAt:
description: When the connection started.
format: date-time
type: string
status:
$ref: '#/components/schemas/ConnectionStatus'
totalBytes:
description: bytesIn + bytesOut.
format: int64
type: integer
userId:
description: The user that made the connection.
format: uuid
type: string
required:
- sessionId
- userId
- proxyId
- srcIp
- dstHost
- dstPort
- protocol
- provider
- country
- bytesIn
- bytesOut
- totalBytes
- startedAt
- endedAt
- durationMs
- status
type: object
LatencySample:
description: An aggregated latency measurement taken through the proxy.
properties:
avgMs:
description: Mean round-trip time over successful probes, in milliseconds.
type: integer
jitterMs:
description: Round-trip time spread (max - min) over successful probes, in milliseconds.
type: integer
maxMs:
description: Maximum round-trip time over successful probes, in milliseconds.
type: integer
measuredAt:
description: When this measurement was taken.
format: date-time
type: string
minMs:
description: Minimum round-trip time over successful probes, in milliseconds.
type: integer
packetLoss:
description: Fraction of probes that failed, 0..1 (1 means the proxy was unreachable; rtt fields are 0).
type: number
samples:
description: Number of probes taken in this measurement.
type: integer
target:
description: The host:port the latency was measured against, through the proxy.
type: string
required:
- target
- samples
- minMs
- avgMs
- maxMs
- jitterMs
- packetLoss
- measuredAt
type: object
CreateProxyRequest:
properties:
country:
description: ISO 3166-1 alpha-2 country code to provision the proxy in.
format: country-code
type: string
name:
description: 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: string
type:
$ref: '#/components/schemas/ProxyType'
required:
- country
- type
type: object
ConnectErrorDetail:
description: A single error, locating an offending input where applicable.
properties:
location:
description: Path to the offending input, e.g. "body.proxyId".
type: string
message:
description: Human-readable description of this error.
type: string
value:
description: The offending value, when available.
required:
- location
- message
type: object
ProxyBillingMode:
enum:
- included
- standalone_paid
type: string
ConnectionStatus:
description: '`active` while the connection is still open (no terminal record yet); `closed` once it has ended.'
enum:
- active
- closed
type: string
responses:
BadRequest:
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ConnectErrorResponse'
description: The request was invalid.
NotFound:
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ConnectErrorResponse'
description: The resource was not found.
Unauthorized:
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ConnectErrorResponse'
description: Missing or invalid credentials.
Conflict:
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ConnectErrorResponse'
description: The request cannot be fulfilled in the current state (e.g. no capacity is available for the requested country/type).
ServiceUnavailable:
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ConnectErrorResponse'
description: Connection history is temporarily unavailable.
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: Opaque
description: Bearer token via Authorization header
x-refined-from:
- openapi.json
- mobilerun-ai-openapi.json
x-provenance:
method: harvested
publisher: Mobilerun
source: https://api.mobilerun.ai/v1/openapi.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)