synthetics_network_tests

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

Overview

Name	synthetics_network_tests
Type	Resource
Id	datadog.monitoring.synthetics_network_tests

Fields

The following fields are returned by SELECT queries:

get_synthetics_network_test

Name	Datatype	Description
id	string	The public ID of the Network Path test. (example: abc-def-123)
attributes	object	Object containing details about a Network Path test.
type	string	Type of response, network_test. (network_test) (default: network_test, example: network_test)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_synthetics_network_test	select	public_id
create_synthetics_network_test	insert	data
update_synthetics_network_test	replace	public_id, 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 Network Path test 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.

SELECT examples

get_synthetics_network_test

OK

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

INSERT examples

create_synthetics_network_test

No description available.

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

Manifest

# Description fields are for documentation purposes
- name: synthetics_network_tests
props:
  - name: data
    description: |
      Data object for creating or editing a Network Path test.
    value:
      attributes:
        config:
          assertions:
            - operator: "{{ operator }}"
              property: "{{ property }}"
              target: {{ target }}
              type: "{{ type }}"
          request:
            destination_service: "{{ destination_service }}"
            e2e_queries: {{ e2e_queries }}
            host: "{{ host }}"
            max_ttl: {{ max_ttl }}
            port: {{ port }}
            source_service: "{{ source_service }}"
            tcp_method: "{{ tcp_method }}"
            timeout: {{ timeout }}
            traceroute_queries: {{ traceroute_queries }}
        locations:
          - "{{ locations }}"
        message: "{{ message }}"
        monitor_id: {{ monitor_id }}
        name: "{{ name }}"
        options:
          min_failure_duration: {{ min_failure_duration }}
          min_location_failed: {{ min_location_failed }}
          monitor_name: "{{ monitor_name }}"
          monitor_options:
            escalation_message: "{{ escalation_message }}"
            notification_preset_name: "{{ notification_preset_name }}"
            renotify_interval: {{ renotify_interval }}
            renotify_occurrences: {{ renotify_occurrences }}
          monitor_priority: {{ monitor_priority }}
          restricted_roles:
            - "{{ restricted_roles }}"
          retry:
            count: {{ count }}
            interval: {{ interval }}
          scheduling:
            timeframes:
              - day: {{ day }}
                from: "{{ from }}"
                to: "{{ to }}"
            timezone: "{{ timezone }}"
          tick_every: {{ tick_every }}
        public_id: "{{ public_id }}"
        status: "{{ status }}"
        subtype: "{{ subtype }}"
        tags:
          - "{{ tags }}"
        type: "{{ type }}"
      type: "{{ type }}"

REPLACE examples

update_synthetics_network_test

No description available.

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