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}
Get an abuse report against the account
abuse_reports.get(strreport_param, AbuseReportGetParams**kwargs) -> AbuseReportGetResponse
GET/accounts/{account_id}/abuse-reports/{report_param}
List abuse reports against the account
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 ReportsSubmitted

List submitted abuse reports
abuse_reports.submitted.list(SubmittedListParams**kwargs) -> SyncV4PagePagination[SubmittedListResponse]
GET/accounts/{account_id}/abuse-reports/submitted
Get a submitted abuse report
abuse_reports.submitted.get(strreport_id, SubmittedGetParams**kwargs) -> SubmittedGetResponse
GET/accounts/{account_id}/abuse-reports/submitted/{report_id}
ModelsExpand Collapse
class SubmittedListResponse: …
reports: List[Report]
id: str

Public report code.

cdate: datetime

Time the report was submitted.

formatdate-time
denial_reason: Optional[Literal["unable_to_confirm", "incomplete_report", "not_on_cloudflare", 10 more]]

Submitter-safe reason for a denied report. Null when unavailable.

One of the following:
"unable_to_confirm"
"incomplete_report"
"not_on_cloudflare"
"duplicate_report"
"content_removed"
"report_details_mismatch"
"no_abuse_found"
"missing_original_work"
"direct_url_required"
"wrong_report_category"
"content_unavailable"
"law_enforcement_referral_required"
"domain_dispute_process_required"
domain: str

Domain identified in the report.

status: Literal["submitted", "accepted", "denied"]

Status visible to the account that submitted the report.

One of the following:
"submitted"
"accepted"
"denied"
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"
submitter: Optional[ReportSubmitter]

Information about the submitter of the report.

company: Optional[str]
email: Optional[str]
name: Optional[str]
telephone: Optional[str]
class SubmittedGetResponse: …
id: str

Public report code.

cdate: datetime

Time the report was submitted.

formatdate-time
denial_reason: Optional[Literal["unable_to_confirm", "incomplete_report", "not_on_cloudflare", 10 more]]

Submitter-safe reason for a denied report. Null when unavailable.

One of the following:
"unable_to_confirm"
"incomplete_report"
"not_on_cloudflare"
"duplicate_report"
"content_removed"
"report_details_mismatch"
"no_abuse_found"
"missing_original_work"
"direct_url_required"
"wrong_report_category"
"content_unavailable"
"law_enforcement_referral_required"
"domain_dispute_process_required"
domain: str

Domain identified in the report.

dsa_attestation: bool

Whether the submitter provided the Digital Services Act attestation.

status: Literal["submitted", "accepted", "denied"]

Status visible to the account that submitted the report.

One of the following:
"submitted"
"accepted"
"denied"
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"
urls: List[str]

URLs supplied with the report.

agent_name: Optional[str]

Authorized agent name supplied with the report.

comments: Optional[str]

Additional comments supplied with the report.

court: Optional[str]

The string “on” when a court proceeding applies to the report; otherwise omitted.

destination_ips: Optional[List[str]]

Destination IP addresses supplied with a network abuse report.

host_notification: Optional[str]

Submitter preference for notifying the hosting provider.

justification: Optional[str]

Evidence supplied with the report.

ncmec_notification: Optional[str]

Submitter preference for notifying NCMEC.

ncsei_subject_representation: Optional[bool]

Representation supplied for an NCSEI report.

original_work: Optional[str]

Original work or targeted brand supplied with the report.

owner_notification: Optional[str]

Submitter preference for notifying the content owner.

ports_protocols: Optional[List[str]]

Ports and protocols supplied with a network abuse report.

reg_who_request: Optional[RegWhoRequest]

RDP-mandated fields for registrar WHOIS data disclosure requests.

reg_who_good_faith_affirmation: bool

Affirmation that the request is made in good faith per RDP 10.2.4. Must be true.

reg_who_lawful_processing_agreement: bool

Agreement to process data lawfully per RDP 10.2.5. Must be true.

reg_who_request_type: Literal["disclosure", "invalid_whois"]

The type of WHOIS data request per RDP procedure.

One of the following:
"disclosure"
"invalid_whois"
reg_who_requested_data_elements: List[Literal["registrant_name", "registrant_organization", "registrant_email", 14 more]]

The specific WHOIS data elements being requested per RDP 10.2.2. Required for all WHOIS requests.

One of the following:
"registrant_name"
"registrant_organization"
"registrant_email"
"registrant_phone"
"registrant_address"
"registrant_address_country"
"registrant_address_postal_code"
"admin_name"
"admin_organization"
"admin_email"
"admin_phone"
"admin_address"
"tech_name"
"tech_organization"
"tech_email"
"tech_phone"
"tech_address"
reg_who_authorization_statement: Optional[str]

Optional authorization statement or power of attorney per RDP 10.2.1.3.

maxLength5000
reg_who_requestor_type: Optional[Literal["government", "corporation", "individual"]]

The nature of the requestor per RDP 10.2.1.2.

One of the following:
"government"
"corporation"
"individual"
reported_country: Optional[str]

Country associated with the reported activity.

reported_user_agent: Optional[str]

User agent associated with the reported activity.

source_ips: Optional[List[str]]

Source IP addresses supplied with a network abuse report.

submitter: Optional[Submitter]

Information about the submitter of the report.

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

Additional abuse classifications supplied with the report.

title: Optional[str]

Title supplied with the report.

udrp: Optional[str]

The string “on” when a UDRP proceeding applies to the report; otherwise omitted.

urs: Optional[str]

The string “on” when a URS proceeding applies to the report; otherwise omitted.

Abuse ReportsSubmittedEmails

List emails sent to an abuse report submitter
abuse_reports.submitted.emails.list(strreport_id, EmailListParams**kwargs) -> SyncV4PagePagination[EmailListResponse]
GET/accounts/{account_id}/abuse-reports/submitted/{report_id}/emails
ModelsExpand Collapse
class EmailListResponse: …
emails: List[Email]
id: str

Unique identifier of the email.

body: str

Body content of the email.

recipient: str

Email address of the recipient.

sent_at: str

When the email was sent. Time in RFC 3339 format (https://www.rfc-editor.org/rfc/rfc3339.html)

subject: str

Subject line of the email.

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", "custom_expression"]

The type of entity targeted by a mitigation.

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

The status of a mitigation

One of the following:
"pending"
"active"
"in_review"
"cancelled"
"removed"
type: str

The type of mitigation applied to a reported entity.

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", "custom_expression"]

The type of entity targeted by a mitigation.

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

The status of a mitigation

One of the following:
"pending"
"active"
"in_review"
"cancelled"
"removed"
type: str

The type of mitigation applied to a reported entity.