ngrok · Schema

ngrok TLS Edge

A TLS Edge defines a TLS endpoint with TLS termination, mutual TLS, backend, and IP restriction configurations.

AI GatewayAPI GatewayComputeDeveloper ToolsGatewaysIngressPlatformProxiesServersTunnels

Properties

Name Type Description
id string Unique identifier for the TLS edge.
description string Human-readable description of the edge.
metadata string Arbitrary user-defined metadata.
created_at string Timestamp when the edge was created.
uri string URI of the edge API resource.
hostports array The host:port combinations that this edge listens on.
backend object The backend configuration for the TLS edge.
ip_restriction object The IP restriction module configuration.
mutual_tls object The mutual TLS module configuration.
tls_termination object The TLS termination module configuration.
View JSON Schema on GitHub

JSON Schema

tls-edge.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/api-evangelist/ngrok/blob/main/json-schema/tls-edge.json",
  "title": "ngrok TLS Edge",
  "description": "A TLS Edge defines a TLS endpoint with TLS termination, mutual TLS, backend, and IP restriction configurations.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the TLS edge."
    },
    "description": {
      "type": "string",
      "description": "Human-readable description of the edge."
    },
    "metadata": {
      "type": "string",
      "description": "Arbitrary user-defined metadata."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the edge was created."
    },
    "uri": {
      "type": "string",
      "description": "URI of the edge API resource."
    },
    "hostports": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The host:port combinations that this edge listens on."
    },
    "backend": {
      "type": "object",
      "description": "The backend configuration for the TLS edge."
    },
    "ip_restriction": {
      "type": "object",
      "description": "The IP restriction module configuration."
    },
    "mutual_tls": {
      "type": "object",
      "description": "The mutual TLS module configuration."
    },
    "tls_termination": {
      "type": "object",
      "description": "The TLS termination module configuration."
    }
  }
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • 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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/tls-edge"
All schemas
curl "https://apis.io/api/v1/json-schemas?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.

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