ngrok

ngrok Edges HTTPS API

HTTPS Edges define HTTPS endpoints with routes and modules.

Documentation GitHub OpenAPI

Operations 5

POST /edges/https Ngrok Create HTTPS Edge #

GET /edges/https Ngrok List HTTPS Edges #

GET /edges/https/{id} Ngrok Get HTTPS Edge #

PATCH /edges/https/{id} Ngrok Update HTTPS Edge #

DELETE /edges/https/{id} Ngrok Delete HTTPS Edge #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/ngrok-edges-https-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Ngrok Abuse Reports Edges HTTPS 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: Edges HTTPS
  description: HTTPS Edges define HTTPS endpoints with routes and modules.
paths:
  /edges/https:
    post:
      operationId: createHttpsEdge
      summary: Ngrok Create HTTPS Edge
      description: Create an HTTPS Edge.
      tags:
      - Edges HTTPS
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                metadata:
                  type: string
                hostports:
                  type: array
                  items:
                    type: string
                  description: Hostports served by this edge.
      responses:
        '201':
          description: HTTPS edge created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpsEdge'
    get:
      operationId: listHttpsEdges
      summary: Ngrok List HTTPS Edges
      description: List all HTTPS Edges on this account.
      tags:
      - Edges HTTPS
      parameters:
      - $ref: '#/components/parameters/BeforeId'
      - $ref: '#/components/parameters/Limit'
      responses:
        '200':
          description: List of HTTPS edges.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpsEdgeList'
  /edges/https/{id}:
    get:
      operationId: getHttpsEdge
      summary: Ngrok Get HTTPS Edge
      description: Get an HTTPS Edge by ID.
      tags:
      - Edges HTTPS
      parameters:
      - $ref: '#/components/parameters/Id'
      responses:
        '200':
          description: HTTPS edge details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpsEdge'
    patch:
      operationId: updateHttpsEdge
      summary: Ngrok Update HTTPS Edge
      description: Update an HTTPS Edge by ID.
      tags:
      - Edges HTTPS
      parameters:
      - $ref: '#/components/parameters/Id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                metadata:
                  type: string
                hostports:
                  type: array
                  items:
                    type: string
      responses:
        '200':
          description: HTTPS edge updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpsEdge'
    delete:
      operationId: deleteHttpsEdge
      summary: Ngrok Delete HTTPS Edge
      description: Delete an HTTPS Edge by ID.
      tags:
      - Edges HTTPS
      parameters:
      - $ref: '#/components/parameters/Id'
      responses:
        '204':
          description: HTTPS edge deleted.
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:
    HttpsEdgeList:
      type: object
      properties:
        https_edges:
          type: array
          items:
            $ref: '#/components/schemas/HttpsEdge'
        uri:
          type: string
        next_page_uri:
          type: string
    HttpsEdge:
      type: object
      properties:
        id:
          type: string
        description:
          type: string
        metadata:
          type: string
        created_at:
          type: string
          format: date-time
        uri:
          type: string
        hostports:
          type: array
          items:
            type: string
        routes:
          type: array
          items:
            type: object
  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 '.

ngrok Edges HTTPS API

Operations 5

Documentation

Specifications

SDKs

Schemas & Data

Other Resources