Skip to main content
GET /v1/regions
Public - no auth required. Used by tunnelbyte regions and as the install-time region picker.

Example

curl https://api.tunnelbyte.dev/v1/regions
Response
{
  "regions": [
    { "code": "fsn", "node_count": 1 },
    { "code": "ash", "node_count": 1 },
    { "code": "sin", "node_count": 1 }
  ]
}

Response shape

FieldTypeNotes
regions[].codestringShort-form region code (matches the provider’s location code).
regions[].node_countintegerActive node count in this region. Always ≥ 1 - regions with zero healthy nodes are omitted.

Notes

  • Cached server-side for 5 seconds. Calling this 100×/sec is wasteful but won’t break anything.
  • The CLI uses this for geo-auto-pick: it fetches the list, then picks the region with the shortest great-circle distance using a static lat/lon table. New regions without a CLI-side coord entry still appear in the list but aren’t auto-pickable until the CLI ships an updated table.
  • tunnelbyte regions shows latency (e.g. 12 ms) but that comes from the CLI pinging each region itself - the API response doesn’t include it. If you’re building your own region picker, either measure latency client-side the same way, or skip it and pick by code / node_count.