Skip to main content

events_indicators

Creates, updates, deletes, gets or lists an events_indicators resource.

Overview

Nameevents_indicators
TypeResource
Idcloudflare.cloudforce_one.events_indicators

Fields

The following fields are returned by SELECT queries:

Returns a paginated list of indicators.

NameDatatypeDescription
propertiesobject
typestring

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_by_accountselectaccount_iddatasetIds, page, pageSize, search, name, indicatorType, relatedEvents, tags, createdAfter, createdBefore, relatedEventsLimit, includeTags, includeTotalCount, formatRetrieves a paginated list of indicators across specified datasets. Use datasetIds=all or datasetIds=* to query all datasets for the account. If no datasetIds provided, uses the default dataset.

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.

NameDatatypeDescription
account_idstringThe Cloudflare account ID.
createdAfterstring (date-time)Filter indicators created on or after this date. Must use ISO 8601 format (e.g., '2024-01-15T00:00:00Z').
createdBeforestring (date-time)Filter indicators created on or before this date. Must use ISO 8601 format (e.g., '2024-12-31T23:59:59Z').
datasetIdsarrayDataset IDs to query indicators from (array of UUIDs), or special value 'all' or '*' to query all datasets. If not provided, uses the default dataset.
formatstringOutput format for indicator data. 'json' returns the default format, 'stix2' returns STIX 2.1 Indicator SDOs.
includeTagsbooleanWhether to include full tag details for each indicator. Defaults to true.
includeTotalCountbooleanWhether to compute accurate total count via COUNT(*). Defaults to false for performance. When false, total_count is an approximation.
indicatorTypestring
namestringFilter indicators by value using substring match (LIKE). Legacy alternative to structured search.
pagenumber
pageSizenumber
relatedEventsarrayFilter by related event IDs
relatedEventsLimitnumberLimit the number of related events returned per indicator. Default: 2. Set to 0 for none, -1 for all events.
tagsarrayFilter by tag values or UUIDs. Indicators must have at least one of the specified tags (OR logic). Supports both tag UUID and tag value.

SELECT examples

Retrieves a paginated list of indicators across specified datasets. Use datasetIds=all or datasetIds=* to query all datasets for the account. If no datasetIds provided, uses the default dataset.

SELECT
properties,
type
FROM cloudflare.cloudforce_one.events_indicators
WHERE account_id = '{{ account_id }}' -- required
AND datasetIds = '{{ datasetIds }}'
AND page = '{{ page }}'
AND pageSize = '{{ pageSize }}'
AND search = '{{ search }}'
AND name = '{{ name }}'
AND indicatorType = '{{ indicatorType }}'
AND relatedEvents = '{{ relatedEvents }}'
AND tags = '{{ tags }}'
AND createdAfter = '{{ createdAfter }}'
AND createdBefore = '{{ createdBefore }}'
AND relatedEventsLimit = '{{ relatedEventsLimit }}'
AND includeTags = '{{ includeTags }}'
AND includeTotalCount = '{{ includeTotalCount }}'
AND format = '{{ format }}'
;