openapi: 3.1.0
info:
  title: Ngrok Abuse Reports Tunnels API
  description: The ngrok API provides programmatic access to all of ngrok's resources. The API is REST-ish. It follows most of the conventions of a REST API but diverges slightly when the REST model does not fit well. The API listens only on port 443 to help avoid any accidental unencrypted requests. All API access requires an API key.
  version: 2.0.0
  contact:
    name: Ngrok
    url: https://ngrok.com
  license:
    name: Proprietary
    url: https://ngrok.com/tos
servers:
- url: https://api.ngrok.com
  description: Ngrok API Production Server
security:
- bearerAuth: []
- apiKeyAuth: []
tags:
- name: Tunnels
  description: Tunnels represent individual tunnels within a tunnel session.
paths:
  /tunnels:
    get:
      operationId: listTunnels
      summary: Ngrok List Tunnels
      description: List all online tunnels currently running on the account.
      tags:
      - Tunnels
      parameters:
      - $ref: '#/components/parameters/BeforeId'
      - $ref: '#/components/parameters/Limit'
      responses:
        '200':
          description: List of tunnels.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TunnelList'
  /tunnels/{id}:
    get:
      operationId: getTunnel
      summary: Ngrok Get Tunnel
      description: Get the details of a tunnel by ID.
      tags:
      - Tunnels
      parameters:
      - $ref: '#/components/parameters/Id'
      responses:
        '200':
          description: Tunnel details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tunnel'
components:
  parameters:
    Id:
      name: id
      in: path
      required: true
      schema:
        type: string
      description: A unique identifier for the resource.
    BeforeId:
      name: before_id
      in: query
      required: false
      schema:
        type: string
      description: An ID to use for pagination. Results returned will be before this ID.
    Limit:
      name: limit
      in: query
      required: false
      schema:
        type: string
      description: The maximum number of results to return. Maximum is 100.
  schemas:
    TunnelList:
      type: object
      properties:
        tunnels:
          type: array
          items:
            $ref: '#/components/schemas/Tunnel'
        uri:
          type: string
        next_page_uri:
          type: string
    Ref:
      type: object
      properties:
        id:
          type: string
          description: A resource identifier.
        uri:
          type: string
          description: A URI for locating a resource.
    Tunnel:
      type: object
      properties:
        id:
          type: string
        public_url:
          type: string
        started_at:
          type: string
          format: date-time
        metadata:
          type: string
        proto:
          type: string
        region:
          type: string
        tunnel_session:
          $ref: '#/components/schemas/Ref'
        endpoint:
          $ref: '#/components/schemas/Ref'
        labels:
          type: object
          additionalProperties:
            type: string
        backends:
          type: array
          items:
            $ref: '#/components/schemas/Ref'
        forwards_to:
          type: string
        uri:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Use an ngrok API key as a Bearer token. Create API keys from the ngrok dashboard or via the API Keys endpoints.
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Pass the API key in the Authorization header prefixed with 'Bearer '.