Mobilerun Users API
Manage your Mobilerun Connect Socks Users
Manage your Mobilerun Connect Socks Users
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-users-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 Users API
version: v1
contact:
name: Droidrun
email: support@droidrun.ai
description: 'Operations tagged Users 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 Socks Users
name: Users
x-group: Mobilerun Proxy
paths:
/connect/users:
get:
description: Returns SOCKS5 users owned by the caller. Passwords are omitted from the list.
operationId: ListUsers
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UserList'
description: The caller's SOCKS5 users, without credentials.
'401':
$ref: '#/components/responses/Unauthorized'
summary: List SOCKS5 users
tags:
- Users
parameters:
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PageSize'
- description: Filter to users bound to this proxy. Users not bound to it (including unbound users) are excluded.
in: query
name: proxyId
schema:
format: uuid
type: string
post:
description: Creates a SOCKS5 credential, optionally bound to a proxy for dedicated routing. Username and password are generated when omitted.
operationId: CreateUser
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUserRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/UserWithSecret'
description: The created user, including its password.
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
summary: Create a SOCKS5 user
tags:
- Users
servers:
- url: https://api.mobilerun.ai
description: Droidrun Cloud API
/connect/users/{id}:
delete:
description: Deletes the SOCKS5 user identified by the path ID, revoking its credentials and any proxy binding. Returns 404 if no such user exists for the caller.
operationId: DeleteUser
responses:
'204':
description: User deleted.
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
summary: Delete a SOCKS5 user
tags:
- Users
parameters:
- $ref: '#/components/parameters/UserID'
get:
description: Returns the SOCKS5 user identified by the path ID. The response includes the user's password.
operationId: GetUser
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UserWithSecret'
description: The user, including its password.
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
summary: Get a SOCKS5 user by ID
tags:
- Users
parameters:
- $ref: '#/components/parameters/UserID'
patch:
description: Rebind the user to a different proxy (or detach it by passing null).
operationId: UpdateUser
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateUserRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/User'
description: The updated user.
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
summary: Update a SOCKS5 user
tags:
- Users
parameters:
- $ref: '#/components/parameters/UserID'
servers:
- url: https://api.mobilerun.ai
description: Droidrun Cloud API
/connect/users/{id}/connections:
get:
description: Returns the connection history recorded for this user, 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: ListUserConnections
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 connections by SOCKS5 user
tags:
- Users
parameters:
- $ref: '#/components/parameters/UserID'
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/ConnSessionId'
- $ref: '#/components/parameters/ConnProxyId'
- $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
components:
parameters:
ConnProvider:
description: Filter to connections served by this upstream provider identifier.
in: query
name: provider
schema:
type: string
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
ConnStartedBefore:
description: Filter to connections that started at or before this time (inclusive).
in: query
name: startedBefore
schema:
format: date-time
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
UserID:
in: path
name: id
required: true
schema:
format: uuid
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
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
ConnProxyId:
description: Filter to connections routed through this proxy.
in: query
name: proxyId
schema:
format: uuid
type: string
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:
User:
description: A SOCKS5 credential without its password.
properties:
createdAt:
format: date-time
type: string
id:
format: uuid
type: string
proxyId:
description: The proxy this user routes to (dedicated routing), or null if unbound.
format: uuid
nullable: true
type: string
username:
type: string
required:
- id
- username
- createdAt
type: object
UserList:
description: A page of SOCKS5 users.
properties:
items:
items:
$ref: '#/components/schemas/User'
type: array
pagination:
$ref: '#/components/schemas/ConnectPaginationMeta'
required:
- items
- pagination
type: object
UserWithSecret:
allOf:
- $ref: '#/components/schemas/User'
- properties:
password:
type: string
required:
- password
type: object
description: A SOCKS5 user including its password. Returned only on create and single-user reads.
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
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
UpdateUserRequest:
properties:
proxyId:
description: Proxy to rebind to, or null to detach. Omit to leave the user's current binding unchanged — only an explicit null detaches.
format: uuid
nullable: true
type: string
x-go-type: nullable.Nullable[openapi_types.UUID]
x-go-type-import:
path: github.com/oapi-codegen/nullable
x-go-type-skip-optional-pointer: true
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
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
CreateUserRequest:
properties:
password:
description: Desired SOCKS5 password, 1-255 bytes (RFC 1929). Generated when omitted.
maxLength: 255
minLength: 1
type: string
proxyId:
description: Proxy to bind the user to for dedicated routing.
format: uuid
type: string
username:
description: Desired SOCKS5 username, 1-255 bytes (RFC 1929). Generated when omitted.
maxLength: 255
minLength: 1
type: string
type: object
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.
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)