mitigations
Creates, updates, deletes, gets or lists a mitigations resource.
Overview
| Name | mitigations |
| Type | Resource |
| Id | cloudflare.abuse_reports.mitigations |
Fields
The following fields are returned by SELECT queries:
- list
List abuse report mitigations successful
| Name | Datatype | Description |
|---|---|---|
id | string | ID of remediation. |
entity_id | string | |
effective_date | string | Date when the mitigation will become active. Time in RFC 3339 format (https://www.rfc-editor.org/rfc/rfc3339.html) (example: 2009-11-10T23:00:00Z) |
entity_type | string | (url_pattern, account, zone) |
status | string | The status of a mitigation (pending, active, in_review, cancelled, removed) |
type | string | The type of mitigation (legal_block, misleading_interstitial, phishing_interstitial, network_block, rate_limit_cache, account_suspend, redirect_video_stream) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | account_id, report_id | page, per_page, sort, type, effective_before, effective_after, status, entity_type | List mitigations done to remediate the abuse report. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
account_id | string | The Cloudflare account ID. |
report_id | string | Abuse Report ID |
effective_after | string | Returns mitigation that were dispatched after the given date |
effective_before | string | Returns mitigations that were dispatched before the given date |
entity_type | string | Filter by the type of entity the mitigation impacts. |
page | integer | Where in pagination to start listing abuse reports |
per_page | integer | How many abuse reports per page to list |
sort | string | A property to sort by, followed by the order |
status | string | Filter by the status of the mitigation. |
type | string | Filter by the type of mitigation. This filter parameter can be specified multiple times to include multiple types of mitigations in the result set, e.g. ?type=rate_limit_cache&type=legal_block. |
SELECT examples
- list
List mitigations done to remediate the abuse report.
SELECT
id,
entity_id,
effective_date,
entity_type,
status,
type
FROM cloudflare.abuse_reports.mitigations
WHERE account_id = '{{ account_id }}' -- required
AND report_id = '{{ report_id }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
AND sort = '{{ sort }}'
AND type = '{{ type }}'
AND effective_before = '{{ effective_before }}'
AND effective_after = '{{ effective_after }}'
AND status = '{{ status }}'
AND entity_type = '{{ entity_type }}'
;