Skip to main content
GET
/
v1
/
tunnels
/
telemetry
Get Live Telemetry
curl --request GET \
  --url https://api.example.com/v1/tunnels/telemetry
{
  "tunnelId": "<string>",
  "receivedAt": "<string>",
  "region": {},
  "metrics": {
    "ttl": 123,
    "opn": 123,
    "rt1Ms": {},
    "rt5Ms": {},
    "p50Ms": {},
    "p90Ms": {},
    "requests": 123,
    "errors": 123,
    "bytes": 123
  },
  "code": "<string>",
  "message": "<string>",
  "details": {}
}

​
Authentication

Requires a valid access token in the Authorization header.

​
Response

Returns an array of live telemetry snapshots, one per active tunnel. Each snapshot represents the most recently ingested metrics.
​
tunnelId
string
UUID of the tunnel.
​
receivedAt
string
ISO 8601 timestamp when the telemetry was received by the API.
​
region
string | null
The region identifier where the telemetry was captured (e.g., “US-EAST”), or null if not specified.
​
metrics
object
Aggregated metrics snapshot.

​
Rate Limiting

This endpoint is rate limited to 600 requests per minute per user.
This endpoint returns live telemetry data that represents the most recent snapshot for each tunnel. The data is updated in near real-time as the CLI submits telemetry via the ingest endpoint.
If a tunnel has not yet submitted any telemetry data, it will not appear in the response array.

​
Example Request

curl -X GET https://api.rs-tunnel.example.com/v1/tunnels/telemetry \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

​
Example Response

[
  {
    "tunnelId": "550e8400-e29b-41d4-a716-446655440000",
    "receivedAt": "2024-03-15T10:32:45.123Z",
    "region": "US-EAST",
    "metrics": {
      "ttl": 1523,
      "opn": 12,
      "rt1Ms": 5.2,
      "rt5Ms": 8.7,
      "p50Ms": 45.3,
      "p90Ms": 123.8,
      "requests": 1500,
      "errors": 23,
      "bytes": 5242880
    }
  },
  {
    "tunnelId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "receivedAt": "2024-03-15T10:32:43.890Z",
    "region": null,
    "metrics": {
      "ttl": 42,
      "opn": 3,
      "rt1Ms": 12.5,
      "rt5Ms": 18.2,
      "p50Ms": 67.8,
      "p90Ms": 210.4,
      "requests": 38,
      "errors": 2,
      "bytes": 245760
    }
  }
]

​
Error Responses

​
code
string
Error code identifier.
​
message
string
Human-readable error message.
​
details
unknown
Additional error details, if available.

​
Common Errors

  • 401 UNAUTHORIZED: Missing or invalid access token
  • 429 RATE_LIMIT_EXCEEDED: Too many requests (limit: 600/minute)

Build docs developers (and LLMs) love

Get started for freeTalk to us