indicators

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

Overview

Name	indicators
Type	Resource
Id	cloudflare.cloudforce_one.indicators

Fields

The following fields are returned by SELECT queries:

get

Returns the indicator.

Name	Datatype	Description
createdAt	string (date-time)
datasetId	string	The dataset ID this indicator belongs to. Included in list responses.
indicatorType	string
relatedEvents	array
tags	array
updatedAt	string (date-time)
uuid	string
value	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, dataset_id, indicator_id		Retrieves a specific indicator by its UUID.
patch_indicator_update	update	account_id, dataset_id, indicator_id		Updates an existing indicator's properties.
delete_indicator_delete	delete	account_id, dataset_id, indicator_id		Deletes a specific indicator by its UUID.
create	exec	account_id, dataset_id, indicatorType, value		Creates a new indicator with the specified type and related datasets.

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.
dataset_id	string	The dataset ID.
indicator_id	string	Indicator UUID.

SELECT examples

get

Retrieves a specific indicator by its UUID.

SELECT
createdAt,
datasetId,
indicatorType,
relatedEvents,
tags,
updatedAt,
uuid,
value
FROM cloudflare.cloudforce_one.indicators
WHERE account_id = '{{ account_id }}' -- required
AND dataset_id = '{{ dataset_id }}' -- required
AND indicator_id = '{{ indicator_id }}' -- required
;

UPDATE examples

patch_indicator_update

Updates an existing indicator's properties.

UPDATE cloudflare.cloudforce_one.indicators
SET 
indicatorType = '{{ indicatorType }}',
relatedEvents = '{{ relatedEvents }}',
tags = '{{ tags }}',
value = '{{ value }}'
WHERE 
account_id = '{{ account_id }}' --required
AND dataset_id = '{{ dataset_id }}' --required
AND indicator_id = '{{ indicator_id }}' --required
RETURNING
createdAt,
datasetId,
indicatorType,
relatedEvents,
tags,
updatedAt,
uuid,
value;

DELETE examples

delete_indicator_delete

Deletes a specific indicator by its UUID.

DELETE FROM cloudflare.cloudforce_one.indicators
WHERE account_id = '{{ account_id }}' --required
AND dataset_id = '{{ dataset_id }}' --required
AND indicator_id = '{{ indicator_id }}' --required
;

Lifecycle Methods

create

Creates a new indicator with the specified type and related datasets.

EXEC cloudflare.cloudforce_one.indicators.create 
@account_id='{{ account_id }}' --required, 
@dataset_id='{{ dataset_id }}' --required 
@@json=
'{
"autoCreateType": {{ autoCreateType }}, 
"indicatorType": "{{ indicatorType }}", 
"relatedEvents": "{{ relatedEvents }}", 
"tags": "{{ tags }}", 
"value": "{{ value }}"
}'
;