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

# List

> Returns a list of all TCP Edges on this account




## OpenAPI

````yaml https://raw.githubusercontent.com/ngrok/ngrok-openapi/refs/heads/main/ngrok.yaml get /edges/tcp
openapi: 3.0.0
info:
  title: ngrok OpenAPI
  version: 1.0.0
servers:
  - url: https://api.ngrok.com
security:
  - authentication: []
paths:
  /edges/tcp:
    get:
      tags:
        - EdgesTCP
      summary: List
      description: |
        Returns a list of all TCP Edges on this account
      operationId: EdgesTcpList
      parameters:
        - $ref: '#/components/parameters/ngrokVersion'
        - name: before_id
          in: query
          required: false
          schema:
            type: string
        - name: limit
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: |
            Returns a list of all TCP Edges on this account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TCPEdgeList'
components:
  parameters:
    ngrokVersion:
      name: ngrok-version
      in: header
      required: true
      schema:
        type: integer
        default: 2
  schemas:
    TCPEdgeList:
      type: object
      properties:
        tcp_edges:
          description: |
            the list of all TCP Edges on this account
          type: array
          items:
            $ref: '#/components/schemas/TCPEdge'
        uri:
          description: |
            URI of the TCP Edge list API resource
          type: string
        next_page_uri:
          description: |
            URI of the next page, or null if there is no next page
          type: string
    TCPEdge:
      type: object
      properties:
        id:
          description: |
            unique identifier of this edge
          type: string
        description:
          description: >
            human-readable description of what this edge will be used for;
            optional, max 255 bytes.
          type: string
        metadata:
          description: >
            arbitrary user-defined machine-readable data of this edge. Optional,
            max 4096 bytes.
          type: string
        created_at:
          description: |
            timestamp when the edge was created, RFC 3339 format
          type: string
        uri:
          description: |
            URI of the edge API resource
          type: string
        hostports:
          description: |
            hostports served by this edge
          type: array
          items:
            type: string
        backend:
          $ref: '#/components/schemas/EndpointBackend'
          description: |
            edge modules
        ip_restriction:
          $ref: '#/components/schemas/EndpointIPPolicy'
          description: n/a
        traffic_policy:
          $ref: '#/components/schemas/EndpointTrafficPolicy'
          description: |
            the traffic policy associated with this edge or null
    EndpointBackend:
      type: object
      properties:
        enabled:
          description: >
            `true` if the module will be applied to traffic, `false` to disable.
            default `true` if unspecified
          type: boolean
        backend:
          $ref: '#/components/schemas/Ref'
          description: |
            backend to be used to back this endpoint
    EndpointIPPolicy:
      type: object
      properties:
        enabled:
          description: >
            `true` if the module will be applied to traffic, `false` to disable.
            default `true` if unspecified
          type: boolean
        ip_policies:
          description: >
            list of all IP policies that will be used to check if a source IP is
            allowed access to the endpoint
          type: array
          items:
            $ref: '#/components/schemas/Ref'
    EndpointTrafficPolicy:
      type: object
      properties:
        enabled:
          description: >
            `true` if the module will be applied to traffic, `false` to disable.
            default `true` if unspecified
          type: boolean
        value:
          description: >
            the traffic policy that should be applied to the traffic on your
            endpoint.
          type: string
    Ref:
      type: object
      properties:
        id:
          description: |
            a resource identifier
          type: string
        uri:
          description: |
            a uri for locating a resource
          type: string
  securitySchemes:
    authentication:
      type: http
      scheme: bearer

````