Class AbuseReports

Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok's terms of service.

Hierarchy

AbuseReports

Index

Constructors

constructor

Methods

create
get

Constructors

constructor

new AbuseReports(httpClient: Wretcher): AbuseReports

- Defined in services.ts:16
Do not construct this object directly, use the abuseReports property of an Ngrok client object instead.

Parameters
- httpClient: Wretcher
Returns AbuseReports

Methods

create

create(arg: AbuseReportCreate): Promise<AbuseReport>

- Defined in services.ts:22
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

Parameters
- arg: AbuseReportCreate
Returns Promise<AbuseReport>

get

get(id: any): Promise<AbuseReport>

- Defined in services.ts:34
Get the detailed status of abuse report by ID.

Parameters
- id: any
Returns Promise<AbuseReport>

Generated using TypeDoc