Skip to main content
POST
Create

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

ngrok-version
integer
default:2
required

Body

application/json
urls
string[]
required

a list of URLs containing suspected abusive content

metadata
string

arbitrary user-defined data about this abuse report. Optional, max 4096 bytes.

Response

201 - application/json

Creates a new abuse report which will be reviewed by our system and abuse response team. This API is only available to authorized accounts. Contact abuse@ngrok.com to request access

id
string

ID of the abuse report

uri
string

URI of the abuse report API resource

created_at
string

timestamp that the abuse report record was created in RFC 3339 format

urls
string[]

a list of URLs containing suspected abusive content

metadata
string

arbitrary user-defined data about this abuse report. Optional, max 4096 bytes.

status
string

Indicates whether ngrok has processed the abuse report. one of PENDING, PROCESSED, or PARTIALLY_PROCESSED

hostnames
object[]

an array of hostname statuses related to the report