synthetics_suites

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

Overview

Name	synthetics_suites
Type	Resource
Id	datadog.monitoring.synthetics_suites

Fields

The following fields are returned by SELECT queries:

get_synthetics_suite

Name	Datatype	Description
id	string	The public ID for the suite. (example: 123-abc-456)
attributes	object	Object containing details about a Synthetic suite.
type	string	Type for the Synthetics suites responses, suites. (suites) (default: suites, example: suites)

search_suites

Name	Datatype	Description
id	string (uuid)	The unique identifier of the suite search response data.
attributes	object	Synthetics suite search response data attributes
type	string	Type for the Synthetics suites search response, suites_search. (suites_search) (default: suites_search, example: suites_search)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_synthetics_suite	select	public_id
search_suites	select		query, sort, facets_only, start, count	Search for test suites.
create_synthetics_suite	insert	data
edit_synthetics_suite	replace	public_id, data
delete_synthetics_suites	exec	data

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
public_id	string	The public ID of the suite to edit.
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.
count	integer (int64)	The maximum number of results to return.
facets_only	boolean	If true, return only facets instead of full test details.
query	string	The search query.
sort	string	The sort order for the results (e.g., name,asc or name,desc).
start	integer (int64)	The offset from which to start returning results.

SELECT examples

get_synthetics_suite

OK

SELECT
id,
attributes,
type
FROM datadog.monitoring.synthetics_suites
WHERE public_id = '{{ public_id }}' -- required
;

search_suites

Search for test suites.

SELECT
id,
attributes,
type
FROM datadog.monitoring.synthetics_suites
WHERE query = '{{ query }}'
AND sort = '{{ sort }}'
AND facets_only = '{{ facets_only }}'
AND start = '{{ start }}'
AND count = '{{ count }}'
;

INSERT examples

create_synthetics_suite

No description available.

INSERT INTO datadog.monitoring.synthetics_suites (
data
)
SELECT 
'{{ data }}' /* required */
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: synthetics_suites
props:
  - name: data
    description: |
      Data object for creating or editing a Synthetic test suite.
    value:
      attributes:
        message: "{{ message }}"
        monitor_id: {{ monitor_id }}
        name: "{{ name }}"
        options:
          alerting_threshold: {{ alerting_threshold }}
        public_id: "{{ public_id }}"
        tags:
          - "{{ tags }}"
        tests:
          - alerting_criticality: "{{ alerting_criticality }}"
            public_id: "{{ public_id }}"
        type: "{{ type }}"
      type: "{{ type }}"

REPLACE examples

edit_synthetics_suite

No description available.

REPLACE datadog.monitoring.synthetics_suites
SET 
data = '{{ data }}'
WHERE 
public_id = '{{ public_id }}' --required
AND data = '{{ data }}' --required
RETURNING
data;

Lifecycle Methods

EXEC variables use wire (API) names.

delete_synthetics_suites

OK

EXEC datadog.monitoring.synthetics_suites.delete_synthetics_suites 
@@json=
'{
"data": "{{ data }}"
}'
;