Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ngrok Abuse Reports API

Abuse Reports allow you to submit reports of abusive endpoints.

ngrok Abuse Reports API is one of 24 APIs that ngrok publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 12 JSON Schema definitions.

Tagged areas include Abuse Reports. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a JSON-LD context, a GitHub repository, and 12 JSON Schemas.

This API exposes 2 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.ngrok.com.

2 operations 2 paths 1 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.ngrok.com
Authentication
HTTP Bearer, API Key
Contact
Resource Areas
1

Authentication & Security 2

ngrok Abuse Reports API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). An API key is passed in the header as Authorization (apiKeyAuth). By default, every request must be authenticated.

  • bearerAuth — Use an ngrok API key as a Bearer token. Create API keys from the ngrok dashboard or via the API Keys endpoints.
  • apiKeyAuth — Pass the API key in the Authorization header prefixed with 'Bearer '.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Abuse Reports 2

Abuse Reports allow you to submit reports of abusive endpoints.

POST
/abuse_reports
Ngrok Create Abuse Report
createAbuseReport body → 201
GET
/abuse_reports/{id}
Ngrok Get Abuse Report
getAbuseReport 1 param → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is AbuseReport (7 properties). Each schema is shown below with its type and property counts.

AbuseReport
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ngrok-abuse-reports-api-openapi.yml Raw ↑

Other APIs ngrok publishes across the network.

ngrok Agent Ingresses API
ngrok API Keys API
ngrok Backends API
ngrok Certificate Authorities API
ngrok Credentials API
ngrok Edges HTTPS API
ngrok Edges TCP API
ngrok Edges TLS API
ngrok Endpoints API
ngrok Event Destinations API
ngrok Event Subscriptions API
ngrok IP Policies API