connections

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

Overview

Name	connections
Type	Resource
Id	cloudflare.page_shield.connections

Fields

The following fields are returned by SELECT queries:

get

Get a Page Shield connection response

Name	Datatype	Description
id	string	Identifier (example: 023e105f4ecef8ad9ca31a8372d0c353)
added_at	string (date-time)	(example: 2021-08-18T10:51:10.09615Z)
domain_reported_malicious	boolean
first_page_url	string	(example: blog.cloudflare.com/page)
first_seen_at	string (date-time)	(example: 2021-08-18T10:51:08Z)
host	string	(example: blog.cloudflare.com)
last_seen_at	string (date-time)	(example: 2021-09-02T09:57:54Z)
malicious_domain_categories	array
malicious_url_categories	array
page_urls	array
url	string	(example: https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/js/bootstrap.min.js)
url_contains_cdn_cgi_path	boolean
url_reported_malicious	boolean

list

List Page Shield connections response

Name	Datatype	Description
id	string	Identifier (example: 023e105f4ecef8ad9ca31a8372d0c353)
added_at	string (date-time)	(example: 2021-08-18T10:51:10.09615Z)
domain_reported_malicious	boolean
first_page_url	string	(example: blog.cloudflare.com/page)
first_seen_at	string (date-time)	(example: 2021-08-18T10:51:08Z)
host	string	(example: blog.cloudflare.com)
last_seen_at	string (date-time)	(example: 2021-09-02T09:57:54Z)
malicious_domain_categories	array
malicious_url_categories	array
page_urls	array
url	string	(example: https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/js/bootstrap.min.js)
url_contains_cdn_cgi_path	boolean
url_reported_malicious	boolean

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	zone_id, connection_id		Fetches a connection detected by Page Shield by connection ID.
list	select	zone_id	exclude_urls, urls, hosts, page, per_page, order_by, direction, prioritize_malicious, exclude_cdn_cgi, status, page_url, export	Lists all connections detected by Page Shield.

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
connection_id	string
zone_id	string	The Cloudflare zone ID.
direction	string
exclude_cdn_cgi	boolean
exclude_urls	string
export	string
hosts	string
order_by	string
page	string
page_url	string
per_page	number
prioritize_malicious	boolean
status	string
urls	string

SELECT examples

get

Fetches a connection detected by Page Shield by connection ID.

SELECT
id,
added_at,
domain_reported_malicious,
first_page_url,
first_seen_at,
host,
last_seen_at,
malicious_domain_categories,
malicious_url_categories,
page_urls,
url,
url_contains_cdn_cgi_path,
url_reported_malicious
FROM cloudflare.page_shield.connections
WHERE zone_id = '{{ zone_id }}' -- required
AND connection_id = '{{ connection_id }}' -- required
;

list

Lists all connections detected by Page Shield.

SELECT
id,
added_at,
domain_reported_malicious,
first_page_url,
first_seen_at,
host,
last_seen_at,
malicious_domain_categories,
malicious_url_categories,
page_urls,
url,
url_contains_cdn_cgi_path,
url_reported_malicious
FROM cloudflare.page_shield.connections
WHERE zone_id = '{{ zone_id }}' -- required
AND exclude_urls = '{{ exclude_urls }}'
AND urls = '{{ urls }}'
AND hosts = '{{ hosts }}'
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
AND order_by = '{{ order_by }}'
AND direction = '{{ direction }}'
AND prioritize_malicious = '{{ prioritize_malicious }}'
AND exclude_cdn_cgi = '{{ exclude_cdn_cgi }}'
AND status = '{{ status }}'
AND page_url = '{{ page_url }}'
AND export = '{{ export }}'
;