Skip to content
Start here

Lists indicators

client.CloudforceOne.ThreatEvents.Indicators.ByDataset.List(ctx, datasetID, params) (*ThreatEventIndicatorByDatasetListResponse, error)
GET/accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/indicators

This method is deprecated. Please use /events/indicators to retrieve a paginated list of indicators.

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)
Cloudforce One WriteCloudforce One Read
ParametersExpand Collapse
datasetID string

Dataset UUID.

formatuuid
params ThreatEventIndicatorByDatasetListParams
AccountID param.Field[string]

Path param: Account ID.

IndicatorType param.Field[string]Optional

Query param

Name param.Field[string]Optional

Query param: Filter by indicator value (substring match)

Page param.Field[float64]Optional

Query param

PageSize param.Field[float64]Optional

Query param

RelatedEvent param.Field[[]string]Optional

Query param: Filter indicators by related event UUID(s). Multiple UUIDs can be provided by repeating the parameter.

ReturnsExpand Collapse
type ThreatEventIndicatorByDatasetListResponse struct{…}
Indicators []ThreatEventIndicatorByDatasetListResponseIndicator
CreatedAt Time
formatdate-time
IndicatorType string
UpdatedAt Time
formatdate-time
UUID string
Value string
DatasetID stringOptional

The dataset ID this indicator belongs to. Included in list responses.

RelatedEvents []ThreatEventIndicatorByDatasetListResponseIndicatorsRelatedEventOptional
DatasetID string
EventID string
EventDate stringOptional

ISO 8601 date of the related event. Null for legacy relationships created before event-date tracking was added.

Tags []ThreatEventIndicatorByDatasetListResponseIndicatorsTagOptional
CategoryName stringOptional
UUID stringOptional
Value stringOptional

Lists indicators

package main

import (
  "context"
  "fmt"

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

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  byDatasets, err := client.CloudforceOne.ThreatEvents.Indicators.ByDataset.List(
    context.TODO(),
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    cloudforce_one.ThreatEventIndicatorByDatasetListParams{
      AccountID: cloudflare.F("account_id"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", byDatasets.Indicators)
}
{
  "indicators": [
    {
      "createdAt": "2022-04-01T00:00:00Z",
      "indicatorType": "domain",
      "updatedAt": "2022-04-01T00:00:00Z",
      "uuid": "12345678-1234-1234-1234-1234567890ab",
      "value": "malicious-domain.com",
      "datasetId": "dataset-uuid-123",
      "relatedEvents": [
        {
          "datasetId": "dataset-uuid-123",
          "eventId": "event-uuid-456",
          "eventDate": "2024-06-15T00:00:00Z"
        }
      ],
      "tags": [
        {
          "categoryName": "categoryName",
          "uuid": "uuid",
          "value": "value"
        }
      ]
    }
  ],
  "pagination": {
    "page": 0,
    "pageSize": 0,
    "totalCount": 0,
    "totalPages": 0
  }
}
Returns Examples
{
  "indicators": [
    {
      "createdAt": "2022-04-01T00:00:00Z",
      "indicatorType": "domain",
      "updatedAt": "2022-04-01T00:00:00Z",
      "uuid": "12345678-1234-1234-1234-1234567890ab",
      "value": "malicious-domain.com",
      "datasetId": "dataset-uuid-123",
      "relatedEvents": [
        {
          "datasetId": "dataset-uuid-123",
          "eventId": "event-uuid-456",
          "eventDate": "2024-06-15T00:00:00Z"
        }
      ],
      "tags": [
        {
          "categoryName": "categoryName",
          "uuid": "uuid",
          "value": "value"
        }
      ]
    }
  ],
  "pagination": {
    "page": 0,
    "pageSize": 0,
    "totalCount": 0,
    "totalPages": 0
  }
}