Abuse Reports¶
Do not construct this object directly, instead access the
abuse_reports
property of an ngrok.Client
object.
-
class
ngrok.services.
AbuseReportsClient
(client)[source]¶ Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok’s terms of service.
-
create
(urls, metadata='')[source]¶ 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
urls (
Sequence
[str
]) – a list of URLs containing suspected abusive contentmetadata (
str
) – arbitrary user-defined data about this abuse report. Optional, max 4096 bytes.
https://ngrok.com/docs/api#api-abuse-reports-create
- Return type
-
get
(id)[source]¶ Get the detailed status of abuse report by ID.
- Parameters
id (
str
) – a resource identifier
https://ngrok.com/docs/api#api-abuse-reports-get
- Return type
-