Users
Connections

List connections by SOCKS5 user

Changed on

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.

get/connect/users/{id}/connections

Request

  • Base URL
    https://api.mobilerun.ai
  • URL
    https://api.mobilerun.ai/connect/users/{id}/connections
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

Query parameters

pageinteger

Page number (1-based).

pageSizeinteger

Number of items per page.

sessionIdstring uuid

Filter to a single connection by its session id.

proxyIdstring uuid

Filter to connections routed through this proxy.

dstHoststring

Filter to connections to this destination host (exact match).

dstPortinteger

Filter to connections to this destination port.

protocol'tcp' | 'udp' | 'unknown'

Transport protocol of a connection.

Filter to connections of this transport protocol.

providerstring

Filter to connections served by this upstream provider identifier.

countrystring

Filter to connections served from this upstream country (ISO 3166-1 alpha-2).

closeReasonstring

Filter to connections that closed with this reason (closed connections only).

status'active' | 'closed'

active while the connection is still open (no terminal record yet); closed once it has ended.

Filter by connection status.

startedAfterstring date-time

Filter to connections that started at or after this time (inclusive).

startedBeforestring date-time

Filter to connections that started at or before this time (inclusive).

endedAfterstring date-time

Filter to connections whose last activity was at or after this time (inclusive).

endedBeforestring date-time

Filter to connections whose last activity was at or before this time (inclusive).

minBytesIninteger

Filter to connections with at least this many bytes received from upstream.

maxBytesIninteger

Filter to connections with at most this many bytes received from upstream.

minBytesOutinteger

Filter to connections with at least this many bytes sent to upstream.

maxBytesOutinteger

Filter to connections with at most this many bytes sent to upstream.

minTotalBytesinteger

Filter to connections with at least this much total traffic (bytesIn + bytesOut).

maxTotalBytesinteger

Filter to connections with at most this much total traffic (bytesIn + bytesOut).

minDurationMsinteger

Filter to connections lasting at least this many milliseconds.

maxDurationMsinteger

Filter to connections lasting at most this many milliseconds.

orderBy'startedAt' | 'endedAt' | 'bytesIn' | 'bytesOut' | 'totalBytes' | 'durationMs'

Property to order the results by.

order'asc' | 'desc'

Sort direction.

Response

A page of connections.

Changes

    • breaking

      added the new path request parameter id

    • 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

      the endpoint scheme security OwnerIDHeader AND UserIDHeader was added to the API