Skip to content
Cloudflare API
Start here
API Reference

Abuse Reports

Submit an abuse report
abuse_reports.create(strreport_param, AbuseReportCreateParams**kwargs) -> AbuseReportCreateResponse
POST/accounts/{account_id}/abuse-reports/{report_param}
Abuse Report Details
abuse_reports.get(strreport_param, AbuseReportGetParams**kwargs) -> AbuseReportGetResponse
GET/accounts/{account_id}/abuse-reports/{report_param}
List abuse reports
abuse_reports.list(AbuseReportListParams**kwargs) -> SyncV4PagePagination[Optional[AbuseReportListResponse]]
GET/accounts/{account_id}/abuse-reports
ModelsExpand Collapse
str

The result should be 'success' for successful response

class AbuseReportGetResponse: …
id: str

Public facing ID of abuse report, aka abuse_rand.

cdate: str

Creation date of report. Time in RFC 3339 format (https://www.rfc-editor.org/rfc/rfc3339.html)

domain: str

Domain that relates to the report.

mitigation_summary: MitigationSummary

A summary of the mitigations related to this report.

accepted_url_count: int

How many of the reported URLs were confirmed as abusive.

active_count: int

How many mitigations are active.

external_host_notified: bool

Whether the report has been forwarded to an external hosting provider.

in_review_count: int

How many mitigations are under review.

pending_count: int

How many mitigations are pending their effective date.

status: Literal["accepted", "in_review"]

An enum value that represents the status of an abuse record

One of the following:
"accepted"
"in_review"
type: Literal["PHISH", "GEN", "THREAT", 6 more]

The abuse report type

One of the following:
"PHISH"
"GEN"
"THREAT"
"DMCA"
"EMER"
"TM"
"REG_WHO"
"NCSEI"
"NETWORK"
justification: Optional[str]

Justification for the report.

original_work: Optional[str]

Original work / Targeted brand in the alleged abuse.

submitter: Optional[Submitter]

Information about the submitter of the report.

company: Optional[str]
email: Optional[str]
name: Optional[str]
telephone: Optional[str]
urls: Optional[List[str]]
class AbuseReportListResponse: …
reports: List[Report]
id: str

Public facing ID of abuse report, aka abuse_rand.

cdate: str

Creation date of report. Time in RFC 3339 format (https://www.rfc-editor.org/rfc/rfc3339.html)

domain: str

Domain that relates to the report.

mitigation_summary: ReportMitigationSummary

A summary of the mitigations related to this report.

accepted_url_count: int

How many of the reported URLs were confirmed as abusive.

active_count: int

How many mitigations are active.

external_host_notified: bool

Whether the report has been forwarded to an external hosting provider.

in_review_count: int

How many mitigations are under review.

pending_count: int

How many mitigations are pending their effective date.

status: Literal["accepted", "in_review"]

An enum value that represents the status of an abuse record

One of the following:
"accepted"
"in_review"
type: Literal["PHISH", "GEN", "THREAT", 6 more]

The abuse report type

One of the following:
"PHISH"
"GEN"
"THREAT"
"DMCA"
"EMER"
"TM"
"REG_WHO"
"NCSEI"
"NETWORK"
justification: Optional[str]

Justification for the report.

original_work: Optional[str]

Original work / Targeted brand in the alleged abuse.

submitter: Optional[ReportSubmitter]

Information about the submitter of the report.

company: Optional[str]
email: Optional[str]
name: Optional[str]
telephone: Optional[str]
urls: Optional[List[str]]

Abuse ReportsMitigations

List abuse report mitigations
abuse_reports.mitigations.list(strreport_id, MitigationListParams**kwargs) -> SyncV4PagePagination[Optional[MitigationListResponse]]
GET/accounts/{account_id}/abuse-reports/{report_id}/mitigations
Request review on mitigations
abuse_reports.mitigations.review(strreport_id, MitigationReviewParams**kwargs) -> SyncSinglePage[MitigationReviewResponse]
POST/accounts/{account_id}/abuse-reports/{report_id}/mitigations/appeal
ModelsExpand Collapse
class MitigationListResponse: …
mitigations: List[Mitigation]
id: str

ID of remediation.

effective_date: str

Date when the mitigation will become active. Time in RFC 3339 format (https://www.rfc-editor.org/rfc/rfc3339.html)

entity_id: str
entity_type: Literal["url_pattern", "account", "zone"]
One of the following:
"url_pattern"
"account"
"zone"
status: Literal["pending", "active", "in_review", 2 more]

The status of a mitigation

One of the following:
"pending"
"active"
"in_review"
"cancelled"
"removed"
type: Literal["legal_block", "misleading_interstitial", "phishing_interstitial", 4 more]

The type of mitigation

One of the following:
"legal_block"
"misleading_interstitial"
"phishing_interstitial"
"network_block"
"rate_limit_cache"
"account_suspend"
"redirect_video_stream"
class MitigationReviewResponse: …
id: str

ID of remediation.

effective_date: str

Date when the mitigation will become active. Time in RFC 3339 format (https://www.rfc-editor.org/rfc/rfc3339.html)

entity_id: str
entity_type: Literal["url_pattern", "account", "zone"]
One of the following:
"url_pattern"
"account"
"zone"
status: Literal["pending", "active", "in_review", 2 more]

The status of a mitigation

One of the following:
"pending"
"active"
"in_review"
"cancelled"
"removed"
type: Literal["legal_block", "misleading_interstitial", "phishing_interstitial", 4 more]

The type of mitigation

One of the following:
"legal_block"
"misleading_interstitial"
"phishing_interstitial"
"network_block"
"rate_limit_cache"
"account_suspend"
"redirect_video_stream"