synthetics_downtime_tests

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

Overview

Name	synthetics_downtime_tests
Type	Resource
Id	datadog.monitoring.synthetics_downtime_tests

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
add_test_to_synthetics_downtime	replace	downtime_id, test_id		Associate a Synthetics test with a downtime.
remove_test_from_synthetics_downtime	delete	downtime_id, test_id		Disassociate a Synthetics test from a downtime.

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
downtime_id	string	The ID of the downtime.
site	string	The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.
test_id	string	The public ID of the Synthetics test to disassociate from the downtime.

REPLACE examples

add_test_to_synthetics_downtime

Associate a Synthetics test with a downtime.

REPLACE datadog.monitoring.synthetics_downtime_tests
SET 
-- No updatable properties
WHERE 
downtime_id = '{{ downtime_id }}' --required
AND test_id = '{{ test_id }}' --required
RETURNING
data;

DELETE examples

remove_test_from_synthetics_downtime

Disassociate a Synthetics test from a downtime.

DELETE FROM datadog.monitoring.synthetics_downtime_tests
WHERE downtime_id = '{{ downtime_id }}' --required
AND test_id = '{{ test_id }}' --required
;