Cloudflare API | Abuse Reports › get

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.

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

reportParam: string

params:

AbuseReportGetParams

account_id: string

(maxLength: 32)

Cloudflare Account ID

Returns

AbuseReportGetResponse{

id: string

Public facing ID of abuse report, aka abuse_rand.

cdate: string

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

domain: string

Domain that relates to the report.

mitigation_summary:

MitigationSummary

A summary of the mitigations related to this report.

status: "accepted" | "in_review"

An enum value that represents the status of an abuse record

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

The abuse report type

justification?: string

Justification for the report.

original_work?: string

Original work / Targeted brand in the alleged abuse.

submitter?:

Information about the submitter of the report.

urls?: Array<string>

Request example

import Cloudflare from 'cloudflare';

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

const abuseReport = await client.abuseReports.get('report_param', {
  account_id: '023e105f4ecef8ad9ca31a8372d0c353',
});

console.log(abuseReport.id);

200Example

{
  "result": {
    "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"
    ]
  },
  "success": true,
  "errors": [
    {
      "message": "message",
      "code": "string"
    }
  ],
  "messages": [
    {
      "message": "message"
    }
  ]
}

client.abuseReports.list(, ):

V4PagePagination

<

AbuseReportListResponse

>

get/accounts/{account_id}/abuse-reports

List the abuse reports for a given account

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.