Cloudflare API | Abuse Reports › create

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

Security

API Token

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

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Parameters

reportParam: string

The report type for submitted reports.

AbuseReportCreateParams =

AbuseReportsDmcaReport

|

AbuseReportsTrademarkReport

|

AbuseReportsGeneralReport

| 5 more...

AbuseReportCreateParamsBase{…}

AbuseReportsDmcaReport extends

AbuseReportCreateParamsBase

{…}

AbuseReportsTrademarkReport extends

AbuseReportCreateParamsBase

{…}

AbuseReportsGeneralReport extends

AbuseReportCreateParamsBase

{…}

AbuseReportsPhishingReport extends

AbuseReportCreateParamsBase

{…}

AbuseReportsCsamReport extends

AbuseReportCreateParamsBase

{…}

AbuseReportsThreatReport extends

AbuseReportCreateParamsBase

{…}

AbuseReportsRegistrarWhoisReport extends

AbuseReportCreateParamsBase

{…}

AbuseReportsNcseiReport extends

AbuseReportCreateParamsBase

{…}

Returns

AbuseReportCreateResponse = string

The result should be 'success' for successful response

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.create('report_param', {
  account_id: '023e105f4ecef8ad9ca31a8372d0c353',
  act: 'abuse_dmca',
  address1: 'x',
  agent_name: 'x',
  agree: 1,
  city: 'x',
  country: 'x',
  email: 'email',
  email2: 'email2',
  host_notification: 'send',
  name: 'x',
  original_work: 'x',
  owner_notification: 'send',
  signature: 'signature',
  state: 'x',
  urls: 'urls',
});

console.log(abuseReport);

200Example

{
  "abuse_rand": "abuse_rand",
  "request": {
    "act": "act"
  },
  "result": "result"
}

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

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.