requests

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

Overview

Name	requests
Type	Resource
Id	cloudflare.cloudforce_one.requests

Fields

The following fields are returned by SELECT queries:

get

Get request 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)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, request_id		Retrieves details for a specific Cloudforce One intelligence request.
create	insert	account_id		Creating a request adds the request into the Cloudforce One queue for analysis. In addition to the content, a short title, type, priority, and releasability should be provided. If one is not provided, a default will be assigned.
update	replace	account_id, request_id		Updating a request alters the request in the Cloudforce One queue. This API may be used to update any attributes of the request after the initial submission. Only fields that you choose to update need to be add to the request body.
delete	delete	account_id, request_id		Deletes a Cloudforce One intelligence request and all associated data.
create_priority	exec	account_id, page, per_page		Lists priority intelligence requests in Cloudforce One.
create_asset	exec	account_id, request_id, page, per_page		Lists assets attached to a Cloudforce One intelligence request.
create_message	exec	account_id, request_id, page, per_page		Lists messages in a Cloudforce One intelligence request conversation.

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

SELECT examples

get

Retrieves details for a specific Cloudforce One intelligence request.

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

INSERT examples

create

Creating a request adds the request into the Cloudforce One queue for analysis. In addition to the content, a short title, type, priority, and releasability should be provided. If one is not provided, a default will be assigned.

INSERT INTO cloudflare.cloudforce_one.requests (
content,
priority,
request_type,
summary,
tlp,
account_id
)
SELECT 
'{{ content }}',
'{{ priority }}',
'{{ request_type }}',
'{{ summary }}',
'{{ tlp }}',
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: requests
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the requests resource.
  - name: content
    value: "{{ content }}"
    description: |
      Request content.
  - name: priority
    value: "{{ priority }}"
    description: |
      Priority for analyzing the request.
  - name: request_type
    value: "{{ request_type }}"
    description: |
      Requested information from request.
  - name: summary
    value: "{{ summary }}"
    description: |
      Brief description of the request.
  - name: tlp
    value: "{{ tlp }}"
    description: |
      The CISA defined Traffic Light Protocol (TLP).
    valid_values: ['clear', 'amber', 'amber-strict', 'green', 'red']

REPLACE examples

update

Updating a request alters the request in the Cloudforce One queue. This API may be used to update any attributes of the request after the initial submission. Only fields that you choose to update need to be add to the request body.

REPLACE cloudflare.cloudforce_one.requests
SET 
content = '{{ content }}',
priority = '{{ priority }}',
request_type = '{{ request_type }}',
summary = '{{ summary }}',
tlp = '{{ tlp }}'
WHERE 
account_id = '{{ account_id }}' --required
AND request_id = '{{ request_id }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Deletes a Cloudforce One intelligence request and all associated data.

DELETE FROM cloudflare.cloudforce_one.requests
WHERE account_id = '{{ account_id }}' --required
AND request_id = '{{ request_id }}' --required
;

Lifecycle Methods

create_priority

Lists priority intelligence requests in Cloudforce One.

EXEC cloudflare.cloudforce_one.requests.create_priority 
@account_id='{{ account_id }}' --required 
@@json=
'{
"page": {{ page }}, 
"per_page": {{ per_page }}
}'
;

create_asset

Lists assets attached to a Cloudforce One intelligence request.

EXEC cloudflare.cloudforce_one.requests.create_asset 
@account_id='{{ account_id }}' --required, 
@request_id='{{ request_id }}' --required 
@@json=
'{
"page": {{ page }}, 
"per_page": {{ per_page }}
}'
;

create_message

Lists messages in a Cloudforce One intelligence request conversation.

EXEC cloudflare.cloudforce_one.requests.create_message 
@account_id='{{ account_id }}' --required, 
@request_id='{{ request_id }}' --required 
@@json=
'{
"after": "{{ after }}", 
"before": "{{ before }}", 
"page": {{ page }}, 
"per_page": {{ per_page }}, 
"sort_by": "{{ sort_by }}", 
"sort_order": "{{ sort_order }}"
}'
;