silences

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

Overview

Name	silences
Type	Resource
Id	cloudflare.alerting.silences

Fields

The following fields are returned by SELECT queries:

get

Get Silence response

Name	Datatype	Description
id	string	Silence ID (example: f878e90c23f44126ae3cfc399f646977)
policy_id	string	The unique identifier of a notification policy (example: 0da2b59ef118439d8097bdfb215203c9)
created_at	string	When the silence was created. (example: 2022-01-01T00:00:00Z)
end_time	string	When the silence ends. (example: 2022-01-01T00:00:00Z)
start_time	string	When the silence starts. (example: 2022-01-01T00:00:00Z)
updated_at	string	When the silence was modified. (example: 2022-01-01T00:00:00Z)

list

List Silences response

Name	Datatype	Description
id	string	Silence ID (example: f878e90c23f44126ae3cfc399f646977)
policy_id	string	The unique identifier of a notification policy (example: 0da2b59ef118439d8097bdfb215203c9)
created_at	string	When the silence was created. (example: 2022-01-01T00:00:00Z)
end_time	string	When the silence ends. (example: 2022-01-01T00:00:00Z)
start_time	string	When the silence starts. (example: 2022-01-01T00:00:00Z)
updated_at	string	When the silence was modified. (example: 2022-01-01T00:00:00Z)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, silence_id		Gets a specific silence for an account.
list	select	account_id		Gets a list of silences for an account.
create	insert	account_id		Creates a new silence for an account.
notification_silences_update_silences	replace	account_id		Updates existing silences for an account.
delete	delete	account_id, silence_id		Deletes an existing silence for an account.

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

SELECT examples

get

Gets a specific silence for an account.

SELECT
id,
policy_id,
created_at,
end_time,
start_time,
updated_at
FROM cloudflare.alerting.silences
WHERE account_id = '{{ account_id }}' -- required
AND silence_id = '{{ silence_id }}' -- required
;

list

Gets a list of silences for an account.

SELECT
id,
policy_id,
created_at,
end_time,
start_time,
updated_at
FROM cloudflare.alerting.silences
WHERE account_id = '{{ account_id }}' -- required
;

INSERT examples

create

Creates a new silence for an account.

INSERT INTO cloudflare.alerting.silences (
account_id
)
SELECT 
'{{ account_id }}'
RETURNING
errors,
messages,
success
;

Manifest

# Description fields are for documentation purposes
- name: silences
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the silences resource.

REPLACE examples

notification_silences_update_silences

Updates existing silences for an account.

REPLACE cloudflare.alerting.silences
SET 
-- No updatable properties
WHERE 
account_id = '{{ account_id }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Deletes an existing silence for an account.

DELETE FROM cloudflare.alerting.silences
WHERE account_id = '{{ account_id }}' --required
AND silence_id = '{{ silence_id }}' --required
;