> ## Documentation Index
> Fetch the complete documentation index at: https://altostrat.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List WAN tunnels across accessible sites

> Returns WAN tunnels across the sites available to the authenticated user. The portal uses this endpoint for live WAN health views.



## OpenAPI

````yaml /api/en/wan-failover.yaml get /failover/tunnels
openapi: 3.0.3
info:
  title: Altostrat WAN Failover API
  version: 1.0.0
  description: >-
    Manage SDX WAN failover service state and WAN tunnel configuration through
    the portal-facing `/failover` and `/wan` gateway paths.
servers:
  - url: https://v1.api.altostrat.io
security:
  - BearerAuth: []
tags:
  - name: Failover Service
    description: Activate and manage the WAN Failover service for a specific site.
  - name: WAN Tunnels
    description: >-
      Manage individual WAN connections (tunnels) for a site's failover
      configuration.
  - name: Helper Endpoints
    description: >-
      Utility endpoints for discovering router information to aid in
      configuration.
paths:
  /failover/tunnels:
    get:
      tags:
        - WAN Tunnels
      summary: List WAN tunnels across accessible sites
      description: >-
        Returns WAN tunnels across the sites available to the authenticated
        user. The portal uses this endpoint for live WAN health views.
      operationId: listAccessibleFailoverTunnels
      responses:
        '200':
          description: A list of WAN tunnels.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Tunnel'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Tunnel:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The unique identifier of the tunnel.
          example: 9c6934c9-586b-47e5-9c59-8669911e8609
        tunnel_ip:
          type: string
          format: ipv4
          description: >-
            The internal IP address assigned to the tunnel interface within the
            Altostrat network.
          example: 100.112.0.5
        name:
          type: string
          description: A user-defined name for the tunnel. Defaults to `WAN {priority}`.
          example: Primary Fibre
        priority:
          type: integer
          description: The failover priority of the tunnel (1 is highest).
          example: 1
        isp:
          type: string
          description: >-
            The name of the Internet Service Provider, detected from the
            tunnel's public IP.
          nullable: true
          example: Google Fiber
        isp_country:
          type: string
          description: The two-letter ISO country code of the ISP.
          nullable: true
          example: US
        isp_asn:
          type: string
          description: The Autonomous System Number (ASN) of the ISP.
          nullable: true
          example: '16509'
        type:
          type: string
          description: The physical or logical type of the WAN connection.
          enum:
            - fibre
            - copper
            - 3g
            - 4g
            - lte
            - 5g
            - ethernet
            - coaxial
            - vsat
            - microwave
            - other
          example: fibre
        gateway:
          type: string
          format: ipv4
          description: The IP address of the upstream gateway for this WAN connection.
          example: 198.51.100.1
        interface:
          type: string
          description: >-
            The name of the physical or logical interface on the on-site router
            used by this tunnel.
          example: ether1-wan
        wan_ip:
          type: string
          format: ipv4
          description: >-
            The public IP address of the WAN connection, as seen by the
            Altostrat network.
          nullable: true
          example: 203.0.113.55
        anycast_ip:
          type: string
          format: ipv4
          description: >-
            The public IP address of the Altostrat concentrator this tunnel
            connects to.
          nullable: true
          example: 192.0.2.10
        profile_ip:
          type: string
          format: ipv4
          description: >-
            The internal IP address of the Altostrat concentrator for this
            tunnel.
          nullable: true
          example: 100.64.0.1
        wan_provider_id:
          type: string
          format: uuid
          description: The identifier for a linked WAN Provider resource.
          nullable: true
          example: 9c6934e8-4660-4927-9c94-013083e9a531
        wan_provider_name:
          type: string
          description: The name of the linked WAN Provider.
          nullable: true
          example: Comcast Business
        connected:
          type: boolean
          description: Indicates whether the tunnel is currently online and connected.
          example: true
        latency:
          type: number
          format: float
          description: The most recently measured latency for the tunnel in milliseconds.
          example: 12.5
        packet_loss:
          type: number
          format: float
          description: The packet loss percentage measured over the last 30 minutes.
          example: 0.1
        dyndns:
          type: string
          description: >-
            A stable DynDNS hostname that resolves to the tunnel's current
            public `wan_ip`.
          example: a1b2c3d4e5f6.onpremdns.net
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          description: A broad category for the error (e.g., 'invalid_request_error').
          example: invalid_request_error
        code:
          type: string
          description: A short, unique string identifying the specific error.
          example: parameter_invalid
        message:
          type: string
          description: A human-readable description of what went wrong.
          example: The value for 'type' must be one of the supported connection types.
        doc_url:
          type: string
          description: >-
            A direct link to the documentation page for this specific error
            code.
          example: https://docs.altostrat.io/errors/parameter_invalid
  responses:
    Unauthorized:
      description: Unauthorized - The API key is missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Enter your JWT in the format: Bearer <token>'

````