suppression

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

Overview

Name	suppression
Type	Resource
Id	cloudflare.zones.suppression

Fields

The following fields are returned by SELECT queries:

get

Returns suppression.

Name	Datatype	Description
result	object

list

Returns suppressed emails.

Name	Datatype	Description
id	string (uuid)
created_at	string (date-time)
email	string (email)
expires_at	string (date-time)
reason	string
zones	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	zone_id, suppression_id
list	select	zone_id	page, per_page, order, direction
post_zones_zone_id_email_sending_suppression	insert	zone_id, email
delete_zones_zone_id_email_sending_suppression_suppression_id	delete	zone_id, suppression_id

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
suppression_id	string
zone_id	string	The Cloudflare zone ID.
direction	string
order	string
page	integer
per_page	integer

SELECT examples

get

Returns suppression.

SELECT
result
FROM cloudflare.zones.suppression
WHERE zone_id = '{{ zone_id }}' -- required
AND suppression_id = '{{ suppression_id }}' -- required
;

list

Returns suppressed emails.

SELECT
id,
created_at,
email,
expires_at,
reason,
zones
FROM cloudflare.zones.suppression
WHERE zone_id = '{{ zone_id }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
AND order = '{{ order }}'
AND direction = '{{ direction }}'
;

INSERT examples

post_zones_zone_id_email_sending_suppression

No description available.

INSERT INTO cloudflare.zones.suppression (
email,
expires_at,
zone_id
)
SELECT 
'{{ email }}' /* required */,
'{{ expires_at }}',
'{{ zone_id }}'
RETURNING
result
;

Manifest

# Description fields are for documentation purposes
- name: suppression
props:
  - name: zone_id
    value: "{{ zone_id }}"
    description: Required parameter for the suppression resource.
  - name: email
    value: "{{ email }}"
  - name: expires_at
    value: "{{ expires_at }}"

DELETE examples

delete_zones_zone_id_email_sending_suppression_suppression_id

No description available.

DELETE FROM cloudflare.zones.suppression
WHERE zone_id = '{{ zone_id }}' --required
AND suppression_id = '{{ suppression_id }}' --required
;