Cloudflare API | Abuse Reports › list

API Reference

Account & User Management

Submit an abuse report

Abuse Report Details

List abuse reports

Resource Sharing

AI

Certificate Management

Certificate Authorities

Client Certificates

Custom Certificates

Custom Hostnames

Keyless Certificates

MTLS Certificates

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

Cloudflare One

DNS

Account Custom Nameservers

Domain/Zone Management

IP Addresses

Media

Networking

Magic Cloud Networking

Magic Network Monitoring

Network Interconnects

Observability

Security Center

Radar

Routing & Performance

Rules

Cloud Connector

Managed Transforms

URL Normalization

Security

Schema Validation

Content Scanning

Leaked Credential Checks

Token Validation

Storage & Databases

R2 Data Catalog

Threat Intelligence

Brand Protection

Workers & Pages

Browser Rendering

Durable Objects

Workers For Platforms

Shared

Abuse Reports

AbuseReports

Methods

client.abuseReports.create(, , ):

AbuseReportCreateResponse

post/accounts/{account_id}/abuse-reports/{report_param}

Submit the Abuse Report of a particular type

client.abuseReports.get(, , ):

AbuseReportGetResponse

get/accounts/{account_id}/abuse-reports/{report_param}

Retrieve the details of an abuse report.

client.abuseReports.list(, ):

V4PagePagination

<

AbuseReportListResponse

>

get/accounts/{account_id}/abuse-reports

List the abuse reports for a given account

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Trust and Safety Write Trust and Safety Read

Parameters

params:

AbuseReportListParams

account_id: string

(maxLength: 32)

Path param: Cloudflare Account ID

created_after?: string

Query param: Returns reports created after the specified date

created_before?: string

Query param: Returns reports created before the specified date

domain?: string

Query param: Filter by domain name related to the abuse report

mitigation_status?: "pending" | "active" | "in_review" | 2 more...

Query param: Filter reports that have any mitigations in the given status.

page?: number

Query param: Where in pagination to start listing abuse reports

per_page?: number

Query param: How many abuse reports per page to list

sort?: string

Query param: A property to sort by, followed by the order (id, cdate, domain, type, status)

status?: "accepted" | "in_review"

Query param: Filter by the status of the report.

type?: "PHISH" | "GEN" | "THREAT" | 6 more...

Query param: Filter by the type of the report.

Returns

AbuseReportListResponse{

reports: Array<

>

Request example

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const abuseReportListResponse of client.abuseReports.list({
  account_id: '023e105f4ecef8ad9ca31a8372d0c353',
})) {
  console.log(abuseReportListResponse.reports);
}

200Example

{
  "success": true,
  "errors": [
    {
      "message": "message"
    }
  ],
  "messages": [
    {
      "message": "message"
    }
  ],
  "result": {
    "reports": [
      {
        "id": "id",
        "cdate": "2009-11-10T23:00:00Z",
        "domain": "domain",
        "mitigation_summary": {
          "accepted_url_count": 0,
          "active_count": 0,
          "external_host_notified": true,
          "in_review_count": 0,
          "pending_count": 0
        },
        "status": "accepted",
        "type": "PHISH",
        "justification": "justification",
        "original_work": "original_work",
        "submitter": {
          "company": "company",
          "email": "email",
          "name": "name",
          "telephone": "telephone"
        },
        "urls": [
          "string"
        ]
      }
    ]
  },
  "result_info": {
    "count": 0,
    "page": 0,
    "per_page": 0,
    "total_count": 0,
    "total_pages": 0
  }
}

Mitigations

AbuseReports.Mitigations

Methods

client.abuseReports.mitigations.list(, , ):

V4PagePagination

<

MitigationListResponse

>

get/accounts/{account_id}/abuse-reports/{report_id}/mitigations

List mitigations done to remediate the abuse report.

client.abuseReports.mitigations.review(, , ):

<

MitigationReviewResponse

>

post/accounts/{account_id}/abuse-reports/{report_id}/mitigations/appeal

Request a review for mitigations on an account.