Skip to main content
GET
/
v1
/
failover
/
{site_id}
/
tunnels
List Tunnels for a Site
curl --request GET \
  --url https://api.altostrat.io/v1/failover/{site_id}/tunnels \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "9c6934c9-586b-47e5-9c59-8669911e8609",
    "tunnel_ip": "100.112.0.5",
    "name": "Primary Fibre",
    "priority": 1,
    "isp": "Google Fiber",
    "isp_country": "US",
    "isp_asn": "16509",
    "type": "fibre",
    "gateway": "198.51.100.1",
    "interface": "ether1-wan",
    "wan_ip": "203.0.113.55",
    "anycast_ip": "192.0.2.10",
    "profile_ip": "100.64.0.1",
    "wan_provider_id": "9c6934e8-4660-4927-9c94-013083e9a531",
    "wan_provider_name": "Comcast Business",
    "connected": true,
    "latency": 12.5,
    "packet_loss": 0.1,
    "dyndns": "a1b2c3d4e5f6.onpremdns.net"
  }
]

Authorizations

โ€‹
Authorization
string
header
required

Enter your JWT in the format: Bearer <token>

Path Parameters

โ€‹
site_id
string<uuid>
required

The unique identifier for the site.

Example:

"9c69345c-8d39-4786-9f17-8153c988c89a"

Response

A list of WAN tunnels for the specified site.

โ€‹
id
string<uuid>

The unique identifier of the tunnel.

Example:

"9c6934c9-586b-47e5-9c59-8669911e8609"

โ€‹
tunnel_ip
string<ipv4>

The internal IP address assigned to the tunnel interface within the Altostrat network.

Example:

"100.112.0.5"

โ€‹
name
string

A user-defined name for the tunnel. Defaults to WAN {priority}.

Example:

"Primary Fibre"

โ€‹
priority
integer

The failover priority of the tunnel (1 is highest).

Example:

1

โ€‹
isp
string | null

The name of the Internet Service Provider, detected from the tunnel's public IP.

Example:

"Google Fiber"

โ€‹
isp_country
string | null

The two-letter ISO country code of the ISP.

Example:

"US"

โ€‹
isp_asn
string | null

The Autonomous System Number (ASN) of the ISP.

Example:

"16509"

โ€‹
type
enum<string>

The physical or logical type of the WAN connection.

Available options:
fibre,
copper,
3g,
4g,
lte,
5g,
ethernet,
coaxial,
vsat,
microwave,
other
Example:

"fibre"

โ€‹
gateway
string<ipv4>

The IP address of the upstream gateway for this WAN connection.

Example:

"198.51.100.1"

โ€‹
interface
string

The name of the physical or logical interface on the on-site router used by this tunnel.

Example:

"ether1-wan"

โ€‹
wan_ip
string<ipv4> | null

The public IP address of the WAN connection, as seen by the Altostrat network.

Example:

"203.0.113.55"

โ€‹
anycast_ip
string<ipv4> | null

The public IP address of the Altostrat concentrator this tunnel connects to.

Example:

"192.0.2.10"

โ€‹
profile_ip
string<ipv4> | null

The internal IP address of the Altostrat concentrator for this tunnel.

Example:

"100.64.0.1"

โ€‹
wan_provider_id
string<uuid> | null

The identifier for a linked WAN Provider resource.

Example:

"9c6934e8-4660-4927-9c94-013083e9a531"

โ€‹
wan_provider_name
string | null

The name of the linked WAN Provider.

Example:

"Comcast Business"

โ€‹
connected
boolean

Indicates whether the tunnel is currently online and connected.

Example:

true

โ€‹
latency
number

The most recently measured latency for the tunnel in milliseconds.

Example:

12.5

โ€‹
packet_loss
number

The packet loss percentage measured over the last 30 minutes.

Example:

0.1

โ€‹
dyndns
string

A stable DynDNS hostname that resolves to the tunnel's current public wan_ip.

Example:

"a1b2c3d4e5f6.onpremdns.net"