Mobilerun Tools/Proxy API

The Tools/Proxy API from Mobilerun — 1 operation(s) for tools/proxy.

GitHub OpenAPI

Operations 3

DELETE /devices/{deviceId}/proxy Disconnect proxy #
GET /devices/{deviceId}/proxy Get proxy connection state #
POST /devices/{deviceId}/proxy Connect proxy #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/mobilerun-ai:mobilerun-ai-tools-proxy-api"
All apis
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.

Get an API 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 Specification

mobilerun-ai-tools-proxy-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Mobilerun Ai Tools/Proxy API
  version: v1
  contact:
    name: Droidrun
    email: support@droidrun.ai
  description: 'Operations tagged Tools/Proxy 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:
- name: Tools/Proxy
paths:
  /devices/{deviceId}/proxy:
    delete:
      description: Disconnects the device's active proxy connection and clears its stored proxy state. Returns successfully if no proxy is connected.
      operationId: disconnect-proxy
      responses:
        '204':
          description: No Content
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Error
      summary: Disconnect proxy
      tags:
      - Tools/Proxy
      x-mint:
        content: 'After disconnecting, the device''s traffic uses its direct network connection again.


          <Note>

          Disconnecting does not revert `smartIp` changes — the device keeps the location, time zone, locale, and carrier settings that were aligned to the previous proxy''s exit IP.

          </Note>


          <Note>

          On some device types, disconnecting always restarts the device to remove the proxy.

          </Note>

          '
      parameters:
      - in: path
        name: deviceId
        required: true
        schema:
          type: string
      - in: header
        name: X-Device-Display-ID
        schema:
          default: 0
          format: int64
          minimum: 0
          type: integer
    get:
      description: Returns the device's current proxy connection state, including whether a proxy is connected and its protocol and name.
      operationId: get-proxy
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetProxyInfo'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Error
      summary: Get proxy connection state
      tags:
      - Tools/Proxy
      x-mint:
        content: 'The `connected` flag is a live check against the device, not just stored state — it can be `false` while `protocol` and `name` still describe a configured proxy whose link has dropped.


          Proxy host and credentials are never returned; you only get back the protocol and the `name` you supplied when connecting.

          '
      parameters:
      - in: path
        name: deviceId
        required: true
        schema:
          type: string
      - in: header
        name: X-Device-Display-ID
        schema:
          default: 0
          format: int64
          minimum: 0
          type: integer
    post:
      description: Routes the device's traffic through a SOCKS5 proxy supplied in the request body, replacing any existing connection. A smartIp option can be used to select an IP automatically; the legacy flat host/port/user/password fields remain supported.
      operationId: connect-proxy
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectProxyBody'
        required: true
      responses:
        '204':
          description: No Content
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Error
      summary: Connect proxy
      tags:
      - Tools/Proxy
      x-mint:
        content: "Provide **exactly one** proxy definition: the `socks5` object, the deprecated flat `host`/`port`/`user`/`password` fields (all four required together), or a Mobilerun Connect `connect` reference (see below). Sending more than one fails validation.\n\n## Mobilerun Connect proxies\n\nInstead of passing credentials, reference a Mobilerun Connect proxy:\n\n```json\n{ \"connect\": { \"id\": \"0d5a…\" } }\n```\n\nfetches the credentials of an existing Connect proxy owned by the device's\nowner (it must be `active` or `cancelling`), while\n\n```json\n{ \"connect\": { \"country\": \"us\" } }\n```\n\nprovisions a rotating **residential** proxy in that country — or reuses the\none previously provisioned for this device when it is still active and in\nthe same country. Provisioning waits up to 60 s for the proxy to become\nactive. If payment is required first, the request fails with\n`402 PAYMENT_REQUIRED` and a `paymentUrl` detail pointing to checkout.\n\nWith `smartIp: true`, the exit-IP precheck probes the proxy for up to ~45 s,\nso a freshly provisioned proxy that is still being routed passes without\ncaller-side retries. If the precheck still fails, the error tells you why:\n\n- `409 CONNECT_PROXY_NOT_ACTIVE` — the proxy is not (or no longer) serving\n  traffic, e.g. still provisioning. Transient while provisioning: retry in a\n  few seconds.\n- A denial that keeps failing while the proxy is `active` usually means the\n  organization is out of prepaid proxy data. The same error can occur briefly\n  during transient failures, so it surfaces as a generic error rather than a\n  billing one: retry, and check your proxy data balance if retries keep\n  failing.\n\nPass exactly one of `id` or `country`, and don't combine `connect` with\n`socks5` or the legacy flat fields. `smartIp` works with all variants.\n\nA proxy provisioned via `country` stays with the device and is cancelled\nautomatically when the device is terminated. Proxies referenced by `id`\nare never cancelled by this API.\n\nWith `smartIp: true`, the API geolocates the proxy's exit IP through the proxy itself and aligns the device to match — GPS location, time zone, locale, and (unless an eSIM is active) mobile carrier and network type.\n\n<Warning>\nA smart IP failure leaves your existing proxy untouched, but a failure while connecting the new proxy can leave the device with no proxy at all. Check the proxy state before retrying.\n</Warning>\n\n<Note>\nOn some device types, an upstream switch on an already-proxied device applies live with no interruption, but the first time a device gets a proxy the device restarts to pick it up.\n</Note>\n"
      parameters:
      - in: path
        name: deviceId
        required: true
        schema:
          type: string
      - in: header
        name: X-Device-Display-ID
        schema:
          default: 0
          format: int64
          minimum: 0
          type: integer
    servers:
    - url: https://api.mobilerun.ai
      description: Droidrun Cloud API
components:
  schemas:
    ConnectProxyBody:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://example.com/schemas/ConnectProxyBody.json
          format: uri
          readOnly: true
          type: string
        connect:
          $ref: '#/components/schemas/Ref'
          description: Mobilerun Connect proxy — pass exactly one of id (use an existing proxy's credentials) or country (provision or reuse a rotating residential proxy for the device).
        host:
          deprecated: true
          format: hostname
          maxLength: 255
          type: string
        name:
          description: Proxy name
          maxLength: 255
          type: string
        password:
          deprecated: true
          maxLength: 255
          type: string
          writeOnly: true
        port:
          deprecated: true
          format: int64
          maximum: 65535
          minimum: 1
          type: integer
        smartIp:
          type: boolean
        socks5:
          $ref: '#/components/schemas/ConnectSOCKS5Config'
          description: SOCKS5 proxy configuration (required for socks5).
        user:
          deprecated: true
          maxLength: 255
          type: string
      type: object
    GetProxyInfo:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://example.com/schemas/GetProxyInfo.json
          format: uri
          readOnly: true
          type: string
        connected:
          type: boolean
        name:
          description: Active proxy name
          type:
          - string
          - 'null'
        protocol:
          description: Active proxy protocol (socks5).
          type:
          - string
          - 'null'
      required:
      - connected
      - protocol
      - name
      type: object
    ErrorModel:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://example.com/schemas/ErrorModel.json
          format: uri
          readOnly: true
          type: string
        detail:
          description: A human-readable explanation specific to this occurrence of the problem.
          examples:
          - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
          - array
          - 'null'
        instance:
          description: A URI reference that identifies the specific occurrence of the problem.
          examples:
          - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
          - 400
          format: int64
          type: integer
        title:
          description: A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
          examples:
          - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
          - https://example.com/errors/example
          format: uri
          type: string
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    Ref:
      additionalProperties: false
      properties:
        country:
          description: ISO 3166-1 alpha-2 country code; provisions (or reuses) a rotating residential Mobilerun Connect proxy for the device.
          pattern: ^[a-zA-Z]{2}$
          type: string
        id:
          description: Existing Mobilerun Connect proxy id; its credentials are fetched server-side.
          format: uuid
          type: string
      type: object
    ConnectSOCKS5Config:
      additionalProperties: false
      properties:
        host:
          format: hostname
          maxLength: 255
          type: string
        password:
          maxLength: 255
          type: string
          writeOnly: true
        port:
          format: int64
          maximum: 65535
          minimum: 1
          type: integer
        user:
          maxLength: 255
          type: string
      required:
      - host
      - port
      type: object
  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)