priority

Creates, updates, deletes, gets or lists a priority resource.

Overview

Name	priority
Type	Resource
Id	cloudflare.cloudforce_one.priority

Fields

The following fields are returned by SELECT queries:

get

Get priority response.

Name	Datatype	Description
id	string	UUID. (example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415)
readable_id	string	Readable Request ID. (example: RFI-2022-000001, title: Request Readable ID)
completed	string (date-time)	(example: 2022-04-01T05:20:00Z)
content	string	Request content. (example: What regions were most effected by the recent DoS?)
created	string (date-time)	(example: 2022-04-01T05:20:00Z)
message_tokens	integer	Tokens for the request messages.
priority	string (date-time)	(example: 2022-04-01T05:20:00Z)
request	string	Requested information from request. (example: Victomology)
status	string	Request Status. (open, accepted, reported, approved, completed, declined) (title: Request Status)
summary	string	Brief description of the request. (example: DoS attack)
tlp	string	The CISA defined Traffic Light Protocol (TLP). (clear, amber, amber-strict, green, red) (title: TLP)
tokens	integer	Tokens for the request.
updated	string (date-time)	(example: 2022-04-01T05:20:00Z)

list

Get priority quota response.

Name	Datatype	Description
anniversary_date	string (date-time)	Anniversary date is when annual quota limit is refreshed. (example: 2022-04-01T05:20:00Z)
quarter_anniversary_date	string (date-time)	Quarter anniversary date is when quota limit is refreshed each quarter. (example: 2022-04-01T05:20:00Z)
quota	integer	Tokens for the quarter.
remaining	integer	Tokens remaining for the quarter.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, priority_id		Retrieves a specific priority intelligence request from Cloudforce One.
list	select	account_id		Retrieves quota usage for Cloudforce One priority requests.
update	replace	account_id, priority_id, labels, priority, requirement, tlp		Updates a priority intelligence request in Cloudforce One.
delete	delete	account_id, priority_id		Deletes a priority intelligence request from Cloudforce One.
new	exec	account_id, labels, priority, requirement, tlp		Creates a new priority intelligence request in Cloudforce One.

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.
priority_id	string

SELECT examples

get

Retrieves a specific priority intelligence request from Cloudforce One.

SELECT
id,
readable_id,
completed,
content,
created,
message_tokens,
priority,
request,
status,
summary,
tlp,
tokens,
updated
FROM cloudflare.cloudforce_one.priority
WHERE account_id = '{{ account_id }}' -- required
AND priority_id = '{{ priority_id }}' -- required
;

list

Retrieves quota usage for Cloudforce One priority requests.

SELECT
anniversary_date,
quarter_anniversary_date,
quota,
remaining
FROM cloudflare.cloudforce_one.priority
WHERE account_id = '{{ account_id }}' -- required
;

REPLACE examples

update

Updates a priority intelligence request in Cloudforce One.

REPLACE cloudflare.cloudforce_one.priority
SET 
labels = '{{ labels }}',
priority = {{ priority }},
requirement = '{{ requirement }}',
tlp = '{{ tlp }}'
WHERE 
account_id = '{{ account_id }}' --required
AND priority_id = '{{ priority_id }}' --required
AND labels = '{{ labels }}' --required
AND priority = '{{ priority }}' --required
AND requirement = '{{ requirement }}' --required
AND tlp = '{{ tlp }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Deletes a priority intelligence request from Cloudforce One.

DELETE FROM cloudflare.cloudforce_one.priority
WHERE account_id = '{{ account_id }}' --required
AND priority_id = '{{ priority_id }}' --required
;

Lifecycle Methods

new

Creates a new priority intelligence request in Cloudforce One.

EXEC cloudflare.cloudforce_one.priority.new 
@account_id='{{ account_id }}' --required 
@@json=
'{
"labels": "{{ labels }}", 
"priority": {{ priority }}, 
"requirement": "{{ requirement }}", 
"tlp": "{{ tlp }}"
}'
;