Request review on mitigations

client.abuseReports.mitigations.review(, , ?): SinglePage<MitigationReviewResponse { id, effective_date, entity_id, 3 more } >

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

Request a review for mitigations on an 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

ParametersExpand Collapse

reportId: string

params: MitigationReviewParams { account_id, appeals }

account_id: string

Path param: Cloudflare Account ID

maxLength32

appeals: Array<Appeal>

Body param: List of mitigations to appeal.

id: string

ID of the mitigation to appeal.

reason: "removed" | "misclassified"

Reason why the customer is appealing.

One of the following:

"removed"

"misclassified"

ReturnsExpand Collapse

MitigationReviewResponse { id, effective_date, entity_id, 3 more }

id: string

ID of remediation.

effective_date: string

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

entity_id: string

entity_type: "url_pattern" | "account" | "zone"

One of the following:

"url_pattern"

"account"

"zone"

status: "pending" | "active" | "in_review" | 2 more

The status of a mitigation

One of the following:

"pending"

"active"

"in_review"

"cancelled"

"removed"

type: "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"

Request review on mitigations

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 mitigationReviewResponse of client.abuseReports.mitigations.review('report_id', {
  account_id: '023e105f4ecef8ad9ca31a8372d0c353',
  appeals: [{ id: 'id', reason: 'misclassified' }],
})) {
  console.log(mitigationReviewResponse.id);
}

{
  "result_info": {
    "count": 0,
    "page": 0,
    "per_page": 0,
    "total_count": 0,
    "total_pages": 0
  },
  "success": true,
  "errors": [
    {
      "message": "message"
    }
  ],
  "messages": [
    {
      "message": "message"
    }
  ],
  "result": [
    {
      "id": "id",
      "effective_date": "2009-11-10T23:00:00Z",
      "entity_id": "entity_id",
      "entity_type": "url_pattern",
      "status": "pending",
      "type": "legal_block"
    }
  ]
}

Returns Examples

{
  "result_info": {
    "count": 0,
    "page": 0,
    "per_page": 0,
    "total_count": 0,
    "total_pages": 0
  },
  "success": true,
  "errors": [
    {
      "message": "message"
    }
  ],
  "messages": [
    {
      "message": "message"
    }
  ],
  "result": [
    {
      "id": "id",
      "effective_date": "2009-11-10T23:00:00Z",
      "entity_id": "entity_id",
      "entity_type": "url_pattern",
      "status": "pending",
      "type": "legal_block"
    }
  ]
}