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

# List local tunnels

<Info>
  Tunnels are not available to customers yet. The production service is disabled
  pending browser-domain isolation, and the planned signed CLI 0.13.1 release is not
  yet published. This page documents the prepared API contract; it does not enable
  the service. See [local tunnels](/guides/local-tunnels) for planned use and risks.
</Info>

Lists the current account's tunnel records, including their hostname, target, access policy, and connection state. A record does not establish that a connector is running or that its website is reachable.

See [local tunnels](/guides/local-tunnels) to start a connector and share its website.


## OpenAPI

````yaml openapi/tunnels-api.json GET /api/v1/tunnels
openapi: 3.1.0
info:
  title: Rigbox Public API
  description: >-
    Gateway-owned public API for Rigbox. The gateway composes its local
    lifecycle API with service-owned exported specs.
  contact:
    name: Rigbox
    url: https://rigbox.dev
  license:
    name: ''
  version: 1.0.0
servers:
  - url: https://api.rigbox.dev
    description: Production gateway
security: []
tags:
  - name: Tunnels
paths:
  /api/v1/tunnels:
    get:
      tags:
        - Tunnels
      operationId: list
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TunnelList'
      security:
        - bearer: []
components:
  schemas:
    TunnelList:
      type: object
      required:
        - items
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Tunnel'
    Tunnel:
      type: object
      required:
        - id
        - user_id
        - hostname
        - target
        - target_fingerprint
        - visibility
        - status
        - policy_epoch
        - connection_generation
        - expires_at
        - created_at
        - updated_at
      properties:
        connection_generation:
          type: integer
          format: int64
        created_at:
          type: string
          format: date-time
        expires_at:
          type: string
          format: date-time
        hostname:
          type: string
        id:
          type: string
        lease_expires_at:
          type:
            - string
            - 'null'
          format: date-time
        policy_epoch:
          type: integer
          format: int64
        status:
          type: string
        target:
          $ref: '#/components/schemas/TunnelTarget'
        target_fingerprint:
          type: string
        updated_at:
          type: string
          format: date-time
        user_id:
          type: string
        visibility:
          type: string
    TunnelTarget:
      type: object
      required:
        - local_ip
        - port
        - scheme
      properties:
        http_host:
          type:
            - string
            - 'null'
        local_ip:
          type: string
        port:
          type: integer
          format: int32
        scheme:
          type: string
        tls_server_name:
          type:
            - string
            - 'null'
      additionalProperties: false
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.