List abuse report mitigations

client.AbuseReports.Mitigations.List(ctx, reportID, params) (*V4PagePagination[MitigationListResponse], error)

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

List mitigations done to remediate the 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 WriteTrust and Safety Read

ParametersExpand Collapse

reportID string

params MitigationListParams

AccountID param.Field[string]

Path param: Cloudflare Account ID

maxLength32

EffectiveAfter param.Field[string]Optional

Query param: Returns mitigation that were dispatched after the given date

EffectiveBefore param.Field[string]Optional

Query param: Returns mitigations that were dispatched before the given date

EntityType param.Field[MitigationListParamsEntityType]Optional

Query param: Filter by the type of entity the mitigation impacts.

const MitigationListParamsEntityTypeURLPattern MitigationListParamsEntityType = "url_pattern"

const MitigationListParamsEntityTypeAccount MitigationListParamsEntityType = "account"

const MitigationListParamsEntityTypeZone MitigationListParamsEntityType = "zone"

const MitigationListParamsEntityTypeCustomExpression MitigationListParamsEntityType = "custom_expression"

Page param.Field[int64]Optional

Query param: Where in pagination to start listing abuse reports

PerPage param.Field[int64]Optional

Query param: How many abuse reports per page to list

Sort param.Field[MitigationListParamsSort]Optional

Query param: A property to sort by, followed by the order

const MitigationListParamsSortTypeAsc MitigationListParamsSort = "type,asc"

const MitigationListParamsSortTypeDesc MitigationListParamsSort = "type,desc"

const MitigationListParamsSortEffectiveDateAsc MitigationListParamsSort = "effective_date,asc"

const MitigationListParamsSortEffectiveDateDesc MitigationListParamsSort = "effective_date,desc"

const MitigationListParamsSortStatusAsc MitigationListParamsSort = "status,asc"

const MitigationListParamsSortStatusDesc MitigationListParamsSort = "status,desc"

const MitigationListParamsSortEntityTypeAsc MitigationListParamsSort = "entity_type,asc"

const MitigationListParamsSortEntityTypeDesc MitigationListParamsSort = "entity_type,desc"

Status param.Field[MitigationListParamsStatus]Optional

Query param: Filter by the status of the mitigation.

const MitigationListParamsStatusPending MitigationListParamsStatus = "pending"

const MitigationListParamsStatusActive MitigationListParamsStatus = "active"

const MitigationListParamsStatusInReview MitigationListParamsStatus = "in_review"

const MitigationListParamsStatusCancelled MitigationListParamsStatus = "cancelled"

const MitigationListParamsStatusRemoved MitigationListParamsStatus = "removed"

Type param.Field[string]Optional

Query param: Filter by the type of mitigation. This filter parameter can be specified multiple times to include multiple types of mitigations in the result set.

ReturnsExpand Collapse

type MitigationListResponse struct{…}

Mitigations []MitigationListResponseMitigation

ID string

ID of remediation.

EffectiveDate string

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

EntityID string

EntityType MitigationListResponseMitigationsEntityType

The type of entity targeted by a mitigation.

One of the following:

const MitigationListResponseMitigationsEntityTypeURLPattern MitigationListResponseMitigationsEntityType = "url_pattern"

const MitigationListResponseMitigationsEntityTypeAccount MitigationListResponseMitigationsEntityType = "account"

const MitigationListResponseMitigationsEntityTypeZone MitigationListResponseMitigationsEntityType = "zone"

const MitigationListResponseMitigationsEntityTypeCustomExpression MitigationListResponseMitigationsEntityType = "custom_expression"

Status MitigationListResponseMitigationsStatus

The status of a mitigation

One of the following:

const MitigationListResponseMitigationsStatusPending MitigationListResponseMitigationsStatus = "pending"

const MitigationListResponseMitigationsStatusActive MitigationListResponseMitigationsStatus = "active"

const MitigationListResponseMitigationsStatusInReview MitigationListResponseMitigationsStatus = "in_review"

const MitigationListResponseMitigationsStatusCancelled MitigationListResponseMitigationsStatus = "cancelled"

const MitigationListResponseMitigationsStatusRemoved MitigationListResponseMitigationsStatus = "removed"

Type string

The type of mitigation applied to a reported entity.

List abuse report mitigations

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/abuse_reports"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  page, err := client.AbuseReports.Mitigations.List(
    context.TODO(),
    "report_id",
    abuse_reports.MitigationListParams{
      AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

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

Returns Examples

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