Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Datadog Provider
  4. API Docs
  5. getSyntheticsTest
Viewing docs for Datadog v5.11.0
published on Tuesday, Sep 15, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-datadog

datadog.getSyntheticsTest

datadog logo
Viewing docs for Datadog v5.11.0
published on Tuesday, Sep 15, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-datadog

    Use this data source to retrieve a Datadog Synthetic Test.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as datadog from "@pulumi/datadog";

// The existing API test another team owns.
const checkoutApi = datadog.getSyntheticsTest({
    testId: "abc-123-xyz",
});
// A browser test over the same journey, kept in lockstep with the API test's
// cadence, coverage, and alerting behavior.
const checkoutBrowser = new datadog.SyntheticsTest("checkout_browser", {
    name: "Checkout journey (browser)",
    type: "browser",
    status: checkoutApi.then(checkoutApi => checkoutApi.status),
    locations: checkoutApi.then(checkoutApi => checkoutApi.locations),
    requestDefinition: {
        method: "GET",
        url: "https://www.example.com/checkout",
    },
    deviceIds: ["laptop_large"],
    optionsList: {
        tickEvery: checkoutApi.then(checkoutApi => checkoutApi.optionsLists?.[0]?.tickEvery),
        minLocationFailed: checkoutApi.then(checkoutApi => checkoutApi.optionsLists?.[0]?.minLocationFailed),
        monitorPriority: checkoutApi.then(checkoutApi => checkoutApi.optionsLists?.[0]?.monitorPriority),
        retry: {
            count: checkoutApi.then(checkoutApi => checkoutApi.optionsLists?.[0]?.retries?.[0]?.count),
            interval: checkoutApi.then(checkoutApi => checkoutApi.optionsLists?.[0]?.retries?.[0]?.interval),
        },
    },
});

    import pulumi
import pulumi_datadog as datadog

# The existing API test another team owns.
checkout_api = datadog.get_synthetics_test(test_id="abc-123-xyz")
# A browser test over the same journey, kept in lockstep with the API test's
# cadence, coverage, and alerting behavior.
checkout_browser = datadog.SyntheticsTest("checkout_browser",
    name="Checkout journey (browser)",
    type="browser",
    status=checkout_api.status,
    locations=checkout_api.locations,
    request_definition={
        "method": "GET",
        "url": "https://www.example.com/checkout",
    },
    device_ids=["laptop_large"],
    options_list={
        "tick_every": checkout_api.options_lists[0].tick_every,
        "min_location_failed": checkout_api.options_lists[0].min_location_failed,
        "monitor_priority": checkout_api.options_lists[0].monitor_priority,
        "retry": {
            "count": checkout_api.options_lists[0].retries[0].count,
            "interval": checkout_api.options_lists[0].retries[0].interval,
        },
    })

    package main

import (
	"github.com/pulumi/pulumi-datadog/sdk/v5/go/datadog"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// The existing API test another team owns.
		checkoutApi, err := datadog.GetSyntheticsTest(ctx, &datadog.LookupSyntheticsTestArgs{
			TestId: "abc-123-xyz",
		}, nil)
		if err != nil {
			return err
		}
		// A browser test over the same journey, kept in lockstep with the API test's
		// cadence, coverage, and alerting behavior.
		_, err = datadog.NewSyntheticsTest(ctx, "checkout_browser", &datadog.SyntheticsTestArgs{
			Name:      pulumi.String("Checkout journey (browser)"),
			Type:      pulumi.String("browser"),
			Status:    pulumi.String(checkoutApi.Status),
			Locations: toPulumiStringArray(checkoutApi.Locations),
			RequestDefinition: &datadog.SyntheticsTestRequestDefinitionArgs{
				Method: pulumi.String("GET"),
				Url:    pulumi.String("https://www.example.com/checkout"),
			},
			DeviceIds: pulumi.StringArray{
				pulumi.String("laptop_large"),
			},
			OptionsList: &datadog.SyntheticsTestOptionsListArgs{
				TickEvery:         pulumi.Int(checkoutApi.OptionsLists[0].TickEvery),
				MinLocationFailed: pulumi.Int(checkoutApi.OptionsLists[0].MinLocationFailed),
				MonitorPriority:   pulumi.Int(checkoutApi.OptionsLists[0].MonitorPriority),
				Retry: &datadog.SyntheticsTestOptionsListRetryArgs{
					Count:    pulumi.Int(checkoutApi.OptionsLists[0].Retries[0].Count),
					Interval: pulumi.Int(checkoutApi.OptionsLists[0].Retries[0].Interval),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
func toPulumiStringArray(arr []string) pulumi.StringArray {
	var pulumiArr pulumi.StringArray
	for _, v := range arr {
		pulumiArr = append(pulumiArr, pulumi.String(v))
	}
	return pulumiArr
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Datadog = Pulumi.Datadog;

return await Deployment.RunAsync(() => 
{
    // The existing API test another team owns.
    var checkoutApi = Datadog.GetSyntheticsTest.Invoke(new()
    {
        TestId = "abc-123-xyz",
    });

    // A browser test over the same journey, kept in lockstep with the API test's
    // cadence, coverage, and alerting behavior.
    var checkoutBrowser = new Datadog.SyntheticsTest("checkout_browser", new()
    {
        Name = "Checkout journey (browser)",
        Type = "browser",
        Status = checkoutApi.Apply(getSyntheticsTestResult => getSyntheticsTestResult.Status),
        Locations = checkoutApi.Apply(getSyntheticsTestResult => getSyntheticsTestResult.Locations),
        RequestDefinition = new Datadog.Inputs.SyntheticsTestRequestDefinitionArgs
        {
            Method = "GET",
            Url = "https://www.example.com/checkout",
        },
        DeviceIds = new[]
        {
            "laptop_large",
        },
        OptionsList = new Datadog.Inputs.SyntheticsTestOptionsListArgs
        {
            TickEvery = checkoutApi.Apply(getSyntheticsTestResult => getSyntheticsTestResult.OptionsLists[0]?.TickEvery),
            MinLocationFailed = checkoutApi.Apply(getSyntheticsTestResult => getSyntheticsTestResult.OptionsLists[0]?.MinLocationFailed),
            MonitorPriority = checkoutApi.Apply(getSyntheticsTestResult => getSyntheticsTestResult.OptionsLists[0]?.MonitorPriority),
            Retry = new Datadog.Inputs.SyntheticsTestOptionsListRetryArgs
            {
                Count = checkoutApi.Apply(getSyntheticsTestResult => getSyntheticsTestResult.OptionsLists[0]?.Retries[0]?.Count),
                Interval = checkoutApi.Apply(getSyntheticsTestResult => getSyntheticsTestResult.OptionsLists[0]?.Retries[0]?.Interval),
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.datadog.DatadogFunctions;
import com.pulumi.datadog.inputs.GetSyntheticsTestArgs;
import com.pulumi.datadog.SyntheticsTest;
import com.pulumi.datadog.SyntheticsTestArgs;
import com.pulumi.datadog.inputs.SyntheticsTestRequestDefinitionArgs;
import com.pulumi.datadog.inputs.SyntheticsTestOptionsListArgs;
import com.pulumi.datadog.inputs.SyntheticsTestOptionsListRetryArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // The existing API test another team owns.
        final var checkoutApi = DatadogFunctions.getSyntheticsTest(GetSyntheticsTestArgs.builder()
            .testId("abc-123-xyz")
            .build());

        // A browser test over the same journey, kept in lockstep with the API test's
        // cadence, coverage, and alerting behavior.
        var checkoutBrowser = new SyntheticsTest("checkoutBrowser", SyntheticsTestArgs.builder()
            .name("Checkout journey (browser)")
            .type("browser")
            .status(checkoutApi.status())
            .locations(checkoutApi.locations())
            .requestDefinition(SyntheticsTestRequestDefinitionArgs.builder()
                .method("GET")
                .url("https://www.example.com/checkout")
                .build())
            .deviceIds("laptop_large")
            .optionsList(SyntheticsTestOptionsListArgs.builder()
                .tickEvery(checkoutApi.optionsLists()[0].tickEvery())
                .minLocationFailed(checkoutApi.optionsLists()[0].minLocationFailed())
                .monitorPriority(checkoutApi.optionsLists()[0].monitorPriority())
                .retry(SyntheticsTestOptionsListRetryArgs.builder()
                    .count(checkoutApi.optionsLists()[0].retries()[0].count())
                    .interval(checkoutApi.optionsLists()[0].retries()[0].interval())
                    .build())
                .build())
            .build());

    }
}

    resources:
  # A browser test over the same journey, kept in lockstep with the API test's
  # cadence, coverage, and alerting behavior.
  checkoutBrowser:
    type: datadog:SyntheticsTest
    name: checkout_browser
    properties:
      name: Checkout journey (browser)
      type: browser
      status: ${checkoutApi.status}
      locations: ${checkoutApi.locations}
      requestDefinition:
        method: GET
        url: https://www.example.com/checkout
      deviceIds:
        - laptop_large
      optionsList:
        tickEvery: ${checkoutApi.optionsLists[0].tickEvery}
        minLocationFailed: ${checkoutApi.optionsLists[0].minLocationFailed}
        monitorPriority: ${checkoutApi.optionsLists[0].monitorPriority}
        retry:
          count: ${checkoutApi.optionsLists[0].retries[0].count}
          interval: ${checkoutApi.optionsLists[0].retries[0].interval}
variables:
  # The existing API test another team owns.
  checkoutApi:
    fn::invoke:
      function: datadog:getSyntheticsTest
      arguments:
        testId: abc-123-xyz

    pulumi {
  required_providers {
    datadog = {
      source = "pulumi/datadog"
    }
  }
}

data "datadog_getsyntheticstest" "checkoutApi" {
  test_id = "abc-123-xyz"
}

# A browser test over the same journey, kept in lockstep with the API test's
# cadence, coverage, and alerting behavior.
resource "datadog_syntheticstest" "checkout_browser" {
  name      = "Checkout journey (browser)"
  type      = "browser"
  status    = data.datadog_getsyntheticstest.checkoutApi.status
  locations = data.datadog_getsyntheticstest.checkoutApi.locations
  request_definition = {
    method = "GET"
    url    = "https://www.example.com/checkout"
  }
  device_ids = ["laptop_large"]
  options_list = {
    tick_every          = data.datadog_getsyntheticstest.checkoutApi.options_lists[0].tick_every
    min_location_failed = data.datadog_getsyntheticstest.checkoutApi.options_lists[0].min_location_failed
    monitor_priority    = data.datadog_getsyntheticstest.checkoutApi.options_lists[0].monitor_priority
    retry = {
      count    = data.datadog_getsyntheticstest.checkoutApi.options_lists[0].retries[0].count
      interval = data.datadog_getsyntheticstest.checkoutApi.options_lists[0].retries[0].interval
    }
  }
}
# The existing API test another team owns.

    Using getSyntheticsTest

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSyntheticsTest(args: GetSyntheticsTestArgs, opts?: InvokeOptions): Promise<GetSyntheticsTestResult>
function getSyntheticsTestOutput(args: GetSyntheticsTestOutputArgs, opts?: InvokeOutputOptions): Output<GetSyntheticsTestResult>
    def get_synthetics_test(test_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetSyntheticsTestResult
def get_synthetics_test_output(test_id: pulumi.Input[Optional[str]] = None,
                        opts: Optional[InvokeOutputOptions] = None) -> Output[GetSyntheticsTestResult]
    func LookupSyntheticsTest(ctx *Context, args *LookupSyntheticsTestArgs, opts ...InvokeOption) (*LookupSyntheticsTestResult, error)
func LookupSyntheticsTestOutput(ctx *Context, args *LookupSyntheticsTestOutputArgs, opts ...InvokeOption) LookupSyntheticsTestResultOutput

    > Note: This function is named LookupSyntheticsTest in the Go SDK.

    public static class GetSyntheticsTest 
{
    public static Task<GetSyntheticsTestResult> InvokeAsync(GetSyntheticsTestArgs args, InvokeOptions? opts = null)
    public static Output<GetSyntheticsTestResult> Invoke(GetSyntheticsTestInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetSyntheticsTestResult> Invoke(GetSyntheticsTestInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetSyntheticsTestResult> getSyntheticsTest(GetSyntheticsTestArgs args, InvokeOptions options)
public static Output<GetSyntheticsTestResult> getSyntheticsTest(GetSyntheticsTestArgs args, InvokeOptions options)
public static Output<GetSyntheticsTestResult> getSyntheticsTest(GetSyntheticsTestArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: datadog:index/getSyntheticsTest:getSyntheticsTest
  arguments:
    # arguments dictionary
    data "datadog_get_synthetics_test" "name" {
    # arguments
}

    The following arguments are supported:

    TestId string
    The synthetic test id or URL to search for
    TestId string
    The synthetic test id or URL to search for
    test_id string
    The synthetic test id or URL to search for
    testId String
    The synthetic test id or URL to search for
    testId string
    The synthetic test id or URL to search for
    test_id str
    The synthetic test id or URL to search for
    testId String
    The synthetic test id or URL to search for

    getSyntheticsTest Result

    The following output properties are available:

    DeviceIds List<string>
    Array with the different device IDs used to run the test. Only set for browser tests.
    Id string
    The provider-assigned unique ID for this managed resource.
    Locations List<string>
    Array of locations used to run the synthetic test.
    Message string
    A message to include with notifications for this synthetic test.
    MobileOptionsLists List<GetSyntheticsTestMobileOptionsList>
    The mobile synthetic test extra options.
    MonitorId int
    ID of the monitor associated with the synthetic test.
    Name string
    The name of the synthetic test.
    OptionsLists List<GetSyntheticsTestOptionsList>
    The synthetic test extra options.
    Status string
    Whether the synthetic test is started (live) or paused (paused).
    Subtype string
    The subtype of the synthetic test. Only set for API tests.
    Tags List<string>
    A list of tags assigned to the synthetic test.
    TestId string
    The synthetic test id or URL to search for
    Type string
    The type of the synthetic test.
    Url string
    The start URL of the synthetic test.
    DeviceIds []string
    Array with the different device IDs used to run the test. Only set for browser tests.
    Id string
    The provider-assigned unique ID for this managed resource.
    Locations []string
    Array of locations used to run the synthetic test.
    Message string
    A message to include with notifications for this synthetic test.
    MobileOptionsLists []GetSyntheticsTestMobileOptionsList
    The mobile synthetic test extra options.
    MonitorId int
    ID of the monitor associated with the synthetic test.
    Name string
    The name of the synthetic test.
    OptionsLists []GetSyntheticsTestOptionsList
    The synthetic test extra options.
    Status string
    Whether the synthetic test is started (live) or paused (paused).
    Subtype string
    The subtype of the synthetic test. Only set for API tests.
    Tags []string
    A list of tags assigned to the synthetic test.
    TestId string
    The synthetic test id or URL to search for
    Type string
    The type of the synthetic test.
    Url string
    The start URL of the synthetic test.
    device_ids list(string)
    Array with the different device IDs used to run the test. Only set for browser tests.
    id string
    The provider-assigned unique ID for this managed resource.
    locations list(string)
    Array of locations used to run the synthetic test.
    message string
    A message to include with notifications for this synthetic test.
    mobile_options_lists list(object)
    The mobile synthetic test extra options.
    monitor_id number
    ID of the monitor associated with the synthetic test.
    name string
    The name of the synthetic test.
    options_lists list(object)
    The synthetic test extra options.
    status string
    Whether the synthetic test is started (live) or paused (paused).
    subtype string
    The subtype of the synthetic test. Only set for API tests.
    tags list(string)
    A list of tags assigned to the synthetic test.
    test_id string
    The synthetic test id or URL to search for
    type string
    The type of the synthetic test.
    url string
    The start URL of the synthetic test.
    deviceIds List<String>
    Array with the different device IDs used to run the test. Only set for browser tests.
    id String
    The provider-assigned unique ID for this managed resource.
    locations List<String>
    Array of locations used to run the synthetic test.
    message String
    A message to include with notifications for this synthetic test.
    mobileOptionsLists List<GetSyntheticsTestMobileOptionsList>
    The mobile synthetic test extra options.
    monitorId Integer
    ID of the monitor associated with the synthetic test.
    name String
    The name of the synthetic test.
    optionsLists List<GetSyntheticsTestOptionsList>
    The synthetic test extra options.
    status String
    Whether the synthetic test is started (live) or paused (paused).
    subtype String
    The subtype of the synthetic test. Only set for API tests.
    tags List<String>
    A list of tags assigned to the synthetic test.
    testId String
    The synthetic test id or URL to search for
    type String
    The type of the synthetic test.
    url String
    The start URL of the synthetic test.
    deviceIds string[]
    Array with the different device IDs used to run the test. Only set for browser tests.
    id string
    The provider-assigned unique ID for this managed resource.
    locations string[]
    Array of locations used to run the synthetic test.
    message string
    A message to include with notifications for this synthetic test.
    mobileOptionsLists GetSyntheticsTestMobileOptionsList[]
    The mobile synthetic test extra options.
    monitorId number
    ID of the monitor associated with the synthetic test.
    name string
    The name of the synthetic test.
    optionsLists GetSyntheticsTestOptionsList[]
    The synthetic test extra options.
    status string
    Whether the synthetic test is started (live) or paused (paused).
    subtype string
    The subtype of the synthetic test. Only set for API tests.
    tags string[]
    A list of tags assigned to the synthetic test.
    testId string
    The synthetic test id or URL to search for
    type string
    The type of the synthetic test.
    url string
    The start URL of the synthetic test.
    device_ids Sequence[str]
    Array with the different device IDs used to run the test. Only set for browser tests.
    id str
    The provider-assigned unique ID for this managed resource.
    locations Sequence[str]
    Array of locations used to run the synthetic test.
    message str
    A message to include with notifications for this synthetic test.
    mobile_options_lists Sequence[GetSyntheticsTestMobileOptionsList]
    The mobile synthetic test extra options.
    monitor_id int
    ID of the monitor associated with the synthetic test.
    name str
    The name of the synthetic test.
    options_lists Sequence[GetSyntheticsTestOptionsList]
    The synthetic test extra options.
    status str
    Whether the synthetic test is started (live) or paused (paused).
    subtype str
    The subtype of the synthetic test. Only set for API tests.
    tags Sequence[str]
    A list of tags assigned to the synthetic test.
    test_id str
    The synthetic test id or URL to search for
    type str
    The type of the synthetic test.
    url str
    The start URL of the synthetic test.
    deviceIds List<String>
    Array with the different device IDs used to run the test. Only set for browser tests.
    id String
    The provider-assigned unique ID for this managed resource.
    locations List<String>
    Array of locations used to run the synthetic test.
    message String
    A message to include with notifications for this synthetic test.
    mobileOptionsLists List<Property Map>
    The mobile synthetic test extra options.
    monitorId Number
    ID of the monitor associated with the synthetic test.
    name String
    The name of the synthetic test.
    optionsLists List<Property Map>
    The synthetic test extra options.
    status String
    Whether the synthetic test is started (live) or paused (paused).
    subtype String
    The subtype of the synthetic test. Only set for API tests.
    tags List<String>
    A list of tags assigned to the synthetic test.
    testId String
    The synthetic test id or URL to search for
    type String
    The type of the synthetic test.
    url String
    The start URL of the synthetic test.

    Supporting Types

    GetSyntheticsTestMobileOptionsList

    AllowApplicationCrash bool
    Whether the application crashing is considered a failure.
    Bindings List<GetSyntheticsTestMobileOptionsListBinding>
    Restriction policy bindings for the Synthetic mobile test.
    Cis List<GetSyntheticsTestMobileOptionsListCi>
    CI/CD options for a Synthetic test.
    DefaultStepTimeout int
    Default timeout for steps in the test (in seconds).
    DeviceIds List<string>
    Array with the different device IDs used to run the test.
    DisableAutoAcceptAlert bool
    Whether to disable automatically accepting alerts during the test.
    MinFailureDuration int
    Minimum amount of time in failure required to trigger an alert (in seconds).
    MobileApplications List<GetSyntheticsTestMobileOptionsListMobileApplication>
    Mobile application to run the test against.
    MonitorName string
    The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
    MonitorOptions List<GetSyntheticsTestMobileOptionsListMonitorOption>
    Object containing the options for a Synthetic test as a monitor (for example, renotification).
    MonitorPriority int
    Integer from 1 (high) to 5 (low) indicating alert severity.
    NoScreenshot bool
    Prevents saving screenshots of the steps.
    RestrictedRoles List<string>
    A list of role identifiers pulled from the Roles API to restrict read and write access. Included for parity with the datadog.SyntheticsTest resource.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    Retries List<GetSyntheticsTestMobileOptionsListRetry>
    Object describing the retry strategy to apply to a Synthetic test.
    Schedulings List<GetSyntheticsTestMobileOptionsListScheduling>
    Object containing timeframes and timezone used for advanced scheduling.
    TickEvery int
    How often the test should run (in seconds).
    AllowApplicationCrash bool
    Whether the application crashing is considered a failure.
    Bindings []GetSyntheticsTestMobileOptionsListBinding
    Restriction policy bindings for the Synthetic mobile test.
    Cis []GetSyntheticsTestMobileOptionsListCi
    CI/CD options for a Synthetic test.
    DefaultStepTimeout int
    Default timeout for steps in the test (in seconds).
    DeviceIds []string
    Array with the different device IDs used to run the test.
    DisableAutoAcceptAlert bool
    Whether to disable automatically accepting alerts during the test.
    MinFailureDuration int
    Minimum amount of time in failure required to trigger an alert (in seconds).
    MobileApplications []GetSyntheticsTestMobileOptionsListMobileApplication
    Mobile application to run the test against.
    MonitorName string
    The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
    MonitorOptions []GetSyntheticsTestMobileOptionsListMonitorOption
    Object containing the options for a Synthetic test as a monitor (for example, renotification).
    MonitorPriority int
    Integer from 1 (high) to 5 (low) indicating alert severity.
    NoScreenshot bool
    Prevents saving screenshots of the steps.
    RestrictedRoles []string
    A list of role identifiers pulled from the Roles API to restrict read and write access. Included for parity with the datadog.SyntheticsTest resource.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    Retries []GetSyntheticsTestMobileOptionsListRetry
    Object describing the retry strategy to apply to a Synthetic test.
    Schedulings []GetSyntheticsTestMobileOptionsListScheduling
    Object containing timeframes and timezone used for advanced scheduling.
    TickEvery int
    How often the test should run (in seconds).
    allow_application_crash bool
    Whether the application crashing is considered a failure.
    bindings list(object)
    Restriction policy bindings for the Synthetic mobile test.
    cis list(object)
    CI/CD options for a Synthetic test.
    default_step_timeout number
    Default timeout for steps in the test (in seconds).
    device_ids list(string)
    Array with the different device IDs used to run the test.
    disable_auto_accept_alert bool
    Whether to disable automatically accepting alerts during the test.
    min_failure_duration number
    Minimum amount of time in failure required to trigger an alert (in seconds).
    mobile_applications list(object)
    Mobile application to run the test against.
    monitor_name string
    The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
    monitor_options list(object)
    Object containing the options for a Synthetic test as a monitor (for example, renotification).
    monitor_priority number
    Integer from 1 (high) to 5 (low) indicating alert severity.
    no_screenshot bool
    Prevents saving screenshots of the steps.
    restricted_roles list(string)
    A list of role identifiers pulled from the Roles API to restrict read and write access. Included for parity with the datadog.SyntheticsTest resource.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    retries list(object)
    Object describing the retry strategy to apply to a Synthetic test.
    schedulings list(object)
    Object containing timeframes and timezone used for advanced scheduling.
    tick_every number
    How often the test should run (in seconds).
    allowApplicationCrash Boolean
    Whether the application crashing is considered a failure.
    bindings List<GetSyntheticsTestMobileOptionsListBinding>
    Restriction policy bindings for the Synthetic mobile test.
    cis List<GetSyntheticsTestMobileOptionsListCi>
    CI/CD options for a Synthetic test.
    defaultStepTimeout Integer
    Default timeout for steps in the test (in seconds).
    deviceIds List<String>
    Array with the different device IDs used to run the test.
    disableAutoAcceptAlert Boolean
    Whether to disable automatically accepting alerts during the test.
    minFailureDuration Integer
    Minimum amount of time in failure required to trigger an alert (in seconds).
    mobileApplications List<GetSyntheticsTestMobileOptionsListMobileApplication>
    Mobile application to run the test against.
    monitorName String
    The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
    monitorOptions List<GetSyntheticsTestMobileOptionsListMonitorOption>
    Object containing the options for a Synthetic test as a monitor (for example, renotification).
    monitorPriority Integer
    Integer from 1 (high) to 5 (low) indicating alert severity.
    noScreenshot Boolean
    Prevents saving screenshots of the steps.
    restrictedRoles List<String>
    A list of role identifiers pulled from the Roles API to restrict read and write access. Included for parity with the datadog.SyntheticsTest resource.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    retries List<GetSyntheticsTestMobileOptionsListRetry>
    Object describing the retry strategy to apply to a Synthetic test.
    schedulings List<GetSyntheticsTestMobileOptionsListScheduling>
    Object containing timeframes and timezone used for advanced scheduling.
    tickEvery Integer
    How often the test should run (in seconds).
    allowApplicationCrash boolean
    Whether the application crashing is considered a failure.
    bindings GetSyntheticsTestMobileOptionsListBinding[]
    Restriction policy bindings for the Synthetic mobile test.
    cis GetSyntheticsTestMobileOptionsListCi[]
    CI/CD options for a Synthetic test.
    defaultStepTimeout number
    Default timeout for steps in the test (in seconds).
    deviceIds string[]
    Array with the different device IDs used to run the test.
    disableAutoAcceptAlert boolean
    Whether to disable automatically accepting alerts during the test.
    minFailureDuration number
    Minimum amount of time in failure required to trigger an alert (in seconds).
    mobileApplications GetSyntheticsTestMobileOptionsListMobileApplication[]
    Mobile application to run the test against.
    monitorName string
    The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
    monitorOptions GetSyntheticsTestMobileOptionsListMonitorOption[]
    Object containing the options for a Synthetic test as a monitor (for example, renotification).
    monitorPriority number
    Integer from 1 (high) to 5 (low) indicating alert severity.
    noScreenshot boolean
    Prevents saving screenshots of the steps.
    restrictedRoles string[]
    A list of role identifiers pulled from the Roles API to restrict read and write access. Included for parity with the datadog.SyntheticsTest resource.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    retries GetSyntheticsTestMobileOptionsListRetry[]
    Object describing the retry strategy to apply to a Synthetic test.
    schedulings GetSyntheticsTestMobileOptionsListScheduling[]
    Object containing timeframes and timezone used for advanced scheduling.
    tickEvery number
    How often the test should run (in seconds).
    allow_application_crash bool
    Whether the application crashing is considered a failure.
    bindings Sequence[GetSyntheticsTestMobileOptionsListBinding]
    Restriction policy bindings for the Synthetic mobile test.
    cis Sequence[GetSyntheticsTestMobileOptionsListCi]
    CI/CD options for a Synthetic test.
    default_step_timeout int
    Default timeout for steps in the test (in seconds).
    device_ids Sequence[str]
    Array with the different device IDs used to run the test.
    disable_auto_accept_alert bool
    Whether to disable automatically accepting alerts during the test.
    min_failure_duration int
    Minimum amount of time in failure required to trigger an alert (in seconds).
    mobile_applications Sequence[GetSyntheticsTestMobileOptionsListMobileApplication]
    Mobile application to run the test against.
    monitor_name str
    The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
    monitor_options Sequence[GetSyntheticsTestMobileOptionsListMonitorOption]
    Object containing the options for a Synthetic test as a monitor (for example, renotification).
    monitor_priority int
    Integer from 1 (high) to 5 (low) indicating alert severity.
    no_screenshot bool
    Prevents saving screenshots of the steps.
    restricted_roles Sequence[str]
    A list of role identifiers pulled from the Roles API to restrict read and write access. Included for parity with the datadog.SyntheticsTest resource.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    retries Sequence[GetSyntheticsTestMobileOptionsListRetry]
    Object describing the retry strategy to apply to a Synthetic test.
    schedulings Sequence[GetSyntheticsTestMobileOptionsListScheduling]
    Object containing timeframes and timezone used for advanced scheduling.
    tick_every int
    How often the test should run (in seconds).
    allowApplicationCrash Boolean
    Whether the application crashing is considered a failure.
    bindings List<Property Map>
    Restriction policy bindings for the Synthetic mobile test.
    cis List<Property Map>
    CI/CD options for a Synthetic test.
    defaultStepTimeout Number
    Default timeout for steps in the test (in seconds).
    deviceIds List<String>
    Array with the different device IDs used to run the test.
    disableAutoAcceptAlert Boolean
    Whether to disable automatically accepting alerts during the test.
    minFailureDuration Number
    Minimum amount of time in failure required to trigger an alert (in seconds).
    mobileApplications List<Property Map>
    Mobile application to run the test against.
    monitorName String
    The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
    monitorOptions List<Property Map>
    Object containing the options for a Synthetic test as a monitor (for example, renotification).
    monitorPriority Number
    Integer from 1 (high) to 5 (low) indicating alert severity.
    noScreenshot Boolean
    Prevents saving screenshots of the steps.
    restrictedRoles List<String>
    A list of role identifiers pulled from the Roles API to restrict read and write access. Included for parity with the datadog.SyntheticsTest resource.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    retries List<Property Map>
    Object describing the retry strategy to apply to a Synthetic test.
    schedulings List<Property Map>
    Object containing timeframes and timezone used for advanced scheduling.
    tickEvery Number
    How often the test should run (in seconds).

    GetSyntheticsTestMobileOptionsListBinding

    Principals List<string>
    List of principals for the binding.
    Relation string
    The relation restriction for the binding.
    Principals []string
    List of principals for the binding.
    Relation string
    The relation restriction for the binding.
    principals list(string)
    List of principals for the binding.
    relation string
    The relation restriction for the binding.
    principals List<String>
    List of principals for the binding.
    relation String
    The relation restriction for the binding.
    principals string[]
    List of principals for the binding.
    relation string
    The relation restriction for the binding.
    principals Sequence[str]
    List of principals for the binding.
    relation str
    The relation restriction for the binding.
    principals List<String>
    List of principals for the binding.
    relation String
    The relation restriction for the binding.

    GetSyntheticsTestMobileOptionsListCi

    ExecutionRule string
    Execution rule for a Synthetics test.
    ExecutionRule string
    Execution rule for a Synthetics test.
    execution_rule string
    Execution rule for a Synthetics test.
    executionRule String
    Execution rule for a Synthetics test.
    executionRule string
    Execution rule for a Synthetics test.
    execution_rule str
    Execution rule for a Synthetics test.
    executionRule String
    Execution rule for a Synthetics test.

    GetSyntheticsTestMobileOptionsListMobileApplication

    ApplicationId string
    The ID of the mobile application.
    ReferenceId string
    The reference ID of the mobile application.
    ReferenceType string
    The reference type of the mobile application.
    ApplicationId string
    The ID of the mobile application.
    ReferenceId string
    The reference ID of the mobile application.
    ReferenceType string
    The reference type of the mobile application.
    application_id string
    The ID of the mobile application.
    reference_id string
    The reference ID of the mobile application.
    reference_type string
    The reference type of the mobile application.
    applicationId String
    The ID of the mobile application.
    referenceId String
    The reference ID of the mobile application.
    referenceType String
    The reference type of the mobile application.
    applicationId string
    The ID of the mobile application.
    referenceId string
    The reference ID of the mobile application.
    referenceType string
    The reference type of the mobile application.
    application_id str
    The ID of the mobile application.
    reference_id str
    The reference ID of the mobile application.
    reference_type str
    The reference type of the mobile application.
    applicationId String
    The ID of the mobile application.
    referenceId String
    The reference ID of the mobile application.
    referenceType String
    The reference type of the mobile application.

    GetSyntheticsTestMobileOptionsListMonitorOption

    EscalationMessage string
    A message to include with a re-notification.
    NotificationPresetName string
    The name of the preset for the notification for the monitor.
    RenotifyInterval int
    Specify a renotification frequency in minutes.
    RenotifyOccurrences int
    The number of times a monitor renotifies. It can only be set if renotifyInterval is set.
    EscalationMessage string
    A message to include with a re-notification.
    NotificationPresetName string
    The name of the preset for the notification for the monitor.
    RenotifyInterval int
    Specify a renotification frequency in minutes.
    RenotifyOccurrences int
    The number of times a monitor renotifies. It can only be set if renotifyInterval is set.
    escalation_message string
    A message to include with a re-notification.
    notification_preset_name string
    The name of the preset for the notification for the monitor.
    renotify_interval number
    Specify a renotification frequency in minutes.
    renotify_occurrences number
    The number of times a monitor renotifies. It can only be set if renotifyInterval is set.
    escalationMessage String
    A message to include with a re-notification.
    notificationPresetName String
    The name of the preset for the notification for the monitor.
    renotifyInterval Integer
    Specify a renotification frequency in minutes.
    renotifyOccurrences Integer
    The number of times a monitor renotifies. It can only be set if renotifyInterval is set.
    escalationMessage string
    A message to include with a re-notification.
    notificationPresetName string
    The name of the preset for the notification for the monitor.
    renotifyInterval number
    Specify a renotification frequency in minutes.
    renotifyOccurrences number
    The number of times a monitor renotifies. It can only be set if renotifyInterval is set.
    escalation_message str
    A message to include with a re-notification.
    notification_preset_name str
    The name of the preset for the notification for the monitor.
    renotify_interval int
    Specify a renotification frequency in minutes.
    renotify_occurrences int
    The number of times a monitor renotifies. It can only be set if renotifyInterval is set.
    escalationMessage String
    A message to include with a re-notification.
    notificationPresetName String
    The name of the preset for the notification for the monitor.
    renotifyInterval Number
    Specify a renotification frequency in minutes.
    renotifyOccurrences Number
    The number of times a monitor renotifies. It can only be set if renotifyInterval is set.

    GetSyntheticsTestMobileOptionsListRetry

    Count int
    Number of retries needed to consider a location as failed before sending a notification alert.
    Interval int
    Interval between a failed test and the next retry in milliseconds.
    Count int
    Number of retries needed to consider a location as failed before sending a notification alert.
    Interval int
    Interval between a failed test and the next retry in milliseconds.
    count number
    Number of retries needed to consider a location as failed before sending a notification alert.
    interval number
    Interval between a failed test and the next retry in milliseconds.
    count Integer
    Number of retries needed to consider a location as failed before sending a notification alert.
    interval Integer
    Interval between a failed test and the next retry in milliseconds.
    count number
    Number of retries needed to consider a location as failed before sending a notification alert.
    interval number
    Interval between a failed test and the next retry in milliseconds.
    count int
    Number of retries needed to consider a location as failed before sending a notification alert.
    interval int
    Interval between a failed test and the next retry in milliseconds.
    count Number
    Number of retries needed to consider a location as failed before sending a notification alert.
    interval Number
    Interval between a failed test and the next retry in milliseconds.

    GetSyntheticsTestMobileOptionsListScheduling

    Timeframes List<GetSyntheticsTestMobileOptionsListSchedulingTimeframe>
    Array containing objects describing the scheduling pattern to apply to each day.
    Timezone string
    Timezone in which the timeframe is based.
    Timeframes []GetSyntheticsTestMobileOptionsListSchedulingTimeframe
    Array containing objects describing the scheduling pattern to apply to each day.
    Timezone string
    Timezone in which the timeframe is based.
    timeframes list(object)
    Array containing objects describing the scheduling pattern to apply to each day.
    timezone string
    Timezone in which the timeframe is based.
    timeframes List<GetSyntheticsTestMobileOptionsListSchedulingTimeframe>
    Array containing objects describing the scheduling pattern to apply to each day.
    timezone String
    Timezone in which the timeframe is based.
    timeframes GetSyntheticsTestMobileOptionsListSchedulingTimeframe[]
    Array containing objects describing the scheduling pattern to apply to each day.
    timezone string
    Timezone in which the timeframe is based.
    timeframes Sequence[GetSyntheticsTestMobileOptionsListSchedulingTimeframe]
    Array containing objects describing the scheduling pattern to apply to each day.
    timezone str
    Timezone in which the timeframe is based.
    timeframes List<Property Map>
    Array containing objects describing the scheduling pattern to apply to each day.
    timezone String
    Timezone in which the timeframe is based.

    GetSyntheticsTestMobileOptionsListSchedulingTimeframe

    Day int
    Number representing the day of the week.
    From string
    The hour of the day on which scheduling starts.
    To string
    The hour of the day on which scheduling ends.
    Day int
    Number representing the day of the week.
    From string
    The hour of the day on which scheduling starts.
    To string
    The hour of the day on which scheduling ends.
    day number
    Number representing the day of the week.
    from string
    The hour of the day on which scheduling starts.
    to string
    The hour of the day on which scheduling ends.
    day Integer
    Number representing the day of the week.
    from String
    The hour of the day on which scheduling starts.
    to String
    The hour of the day on which scheduling ends.
    day number
    Number representing the day of the week.
    from string
    The hour of the day on which scheduling starts.
    to string
    The hour of the day on which scheduling ends.
    day int
    Number representing the day of the week.
    from_ str
    The hour of the day on which scheduling starts.
    to str
    The hour of the day on which scheduling ends.
    day Number
    Number representing the day of the week.
    from String
    The hour of the day on which scheduling starts.
    to String
    The hour of the day on which scheduling ends.

    GetSyntheticsTestOptionsList

    AcceptSelfSigned bool
    For SSL tests, whether or not the test should allow self signed certificates.
    AllowInsecure bool
    Allows loading insecure content for a request in an API test or in a multistep API test step.
    BlockedRequestPatterns List<string>
    Blocked URL patterns. Requests made to URLs matching any of the patterns listed here will be blocked.
    CaptureNetworkPayloads bool
    Capture HTTP request/response headers and bodies for Fetch/XHR calls made during browser tests.
    CheckCertificateRevocation bool
    For SSL tests, whether or not the test should fail on revoked certificate in stapled OCSP.
    Cis List<GetSyntheticsTestOptionsListCi>
    CI/CD options for a Synthetic test.
    DisableAiaIntermediateFetching bool
    For SSL tests, whether or not the test should disable fetching intermediate certificates from AIA.
    DisableCors bool
    Disable Cross-Origin Resource Sharing for browser tests.
    DisableCsp bool
    Disable Content Security Policy for browser tests.
    FollowRedirects bool
    Determines whether or not the API HTTP test should follow redirects.
    HttpVersion string
    HTTP version to use for an HTTP request in an API test or step.
    IgnoreCertificateValidation bool
    Ignore server certificate error for SSL tests.
    IgnoreServerCertificateError bool
    Ignore server certificate error for browser tests.
    InitialNavigationTimeout int
    Timeout before declaring the initial step as failed (in seconds) for browser tests.
    MinFailureDuration int
    Minimum amount of time in failure required to trigger an alert (in seconds).
    MinLocationFailed int
    Minimum number of locations in failure required to trigger an alert.
    MonitorName string
    The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
    MonitorOptions List<GetSyntheticsTestOptionsListMonitorOption>
    Object containing the options for a Synthetic test as a monitor (for example, renotification).
    MonitorPriority int
    Integer from 1 (high) to 5 (low) indicating alert severity.
    NoScreenshot bool
    Prevents saving screenshots of the steps.
    RestrictedRoles List<string>
    A list of role identifiers pulled from the Roles API to restrict read and write access. Included for parity with the datadog.SyntheticsTest resource.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    Retries List<GetSyntheticsTestOptionsListRetry>
    Object describing the retry strategy to apply to a Synthetic test.
    RumSettings List<GetSyntheticsTestOptionsListRumSetting>
    The RUM data collection settings for the Synthetic browser test.
    Schedulings List<GetSyntheticsTestOptionsListScheduling>
    Object containing timeframes and timezone used for advanced scheduling.
    TickEvery int
    How often the test should run (in seconds).
    AcceptSelfSigned bool
    For SSL tests, whether or not the test should allow self signed certificates.
    AllowInsecure bool
    Allows loading insecure content for a request in an API test or in a multistep API test step.
    BlockedRequestPatterns []string
    Blocked URL patterns. Requests made to URLs matching any of the patterns listed here will be blocked.
    CaptureNetworkPayloads bool
    Capture HTTP request/response headers and bodies for Fetch/XHR calls made during browser tests.
    CheckCertificateRevocation bool
    For SSL tests, whether or not the test should fail on revoked certificate in stapled OCSP.
    Cis []GetSyntheticsTestOptionsListCi
    CI/CD options for a Synthetic test.
    DisableAiaIntermediateFetching bool
    For SSL tests, whether or not the test should disable fetching intermediate certificates from AIA.
    DisableCors bool
    Disable Cross-Origin Resource Sharing for browser tests.
    DisableCsp bool
    Disable Content Security Policy for browser tests.
    FollowRedirects bool
    Determines whether or not the API HTTP test should follow redirects.
    HttpVersion string
    HTTP version to use for an HTTP request in an API test or step.
    IgnoreCertificateValidation bool
    Ignore server certificate error for SSL tests.
    IgnoreServerCertificateError bool
    Ignore server certificate error for browser tests.
    InitialNavigationTimeout int
    Timeout before declaring the initial step as failed (in seconds) for browser tests.
    MinFailureDuration int
    Minimum amount of time in failure required to trigger an alert (in seconds).
    MinLocationFailed int
    Minimum number of locations in failure required to trigger an alert.
    MonitorName string
    The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
    MonitorOptions []GetSyntheticsTestOptionsListMonitorOption
    Object containing the options for a Synthetic test as a monitor (for example, renotification).
    MonitorPriority int
    Integer from 1 (high) to 5 (low) indicating alert severity.
    NoScreenshot bool
    Prevents saving screenshots of the steps.
    RestrictedRoles []string
    A list of role identifiers pulled from the Roles API to restrict read and write access. Included for parity with the datadog.SyntheticsTest resource.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    Retries []GetSyntheticsTestOptionsListRetry
    Object describing the retry strategy to apply to a Synthetic test.
    RumSettings []GetSyntheticsTestOptionsListRumSetting
    The RUM data collection settings for the Synthetic browser test.
    Schedulings []GetSyntheticsTestOptionsListScheduling
    Object containing timeframes and timezone used for advanced scheduling.
    TickEvery int
    How often the test should run (in seconds).
    accept_self_signed bool
    For SSL tests, whether or not the test should allow self signed certificates.
    allow_insecure bool
    Allows loading insecure content for a request in an API test or in a multistep API test step.
    blocked_request_patterns list(string)
    Blocked URL patterns. Requests made to URLs matching any of the patterns listed here will be blocked.
    capture_network_payloads bool
    Capture HTTP request/response headers and bodies for Fetch/XHR calls made during browser tests.
    check_certificate_revocation bool
    For SSL tests, whether or not the test should fail on revoked certificate in stapled OCSP.
    cis list(object)
    CI/CD options for a Synthetic test.
    disable_aia_intermediate_fetching bool
    For SSL tests, whether or not the test should disable fetching intermediate certificates from AIA.
    disable_cors bool
    Disable Cross-Origin Resource Sharing for browser tests.
    disable_csp bool
    Disable Content Security Policy for browser tests.
    follow_redirects bool
    Determines whether or not the API HTTP test should follow redirects.
    http_version string
    HTTP version to use for an HTTP request in an API test or step.
    ignore_certificate_validation bool
    Ignore server certificate error for SSL tests.
    ignore_server_certificate_error bool
    Ignore server certificate error for browser tests.
    initial_navigation_timeout number
    Timeout before declaring the initial step as failed (in seconds) for browser tests.
    min_failure_duration number
    Minimum amount of time in failure required to trigger an alert (in seconds).
    min_location_failed number
    Minimum number of locations in failure required to trigger an alert.
    monitor_name string
    The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
    monitor_options list(object)
    Object containing the options for a Synthetic test as a monitor (for example, renotification).
    monitor_priority number
    Integer from 1 (high) to 5 (low) indicating alert severity.
    no_screenshot bool
    Prevents saving screenshots of the steps.
    restricted_roles list(string)
    A list of role identifiers pulled from the Roles API to restrict read and write access. Included for parity with the datadog.SyntheticsTest resource.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    retries list(object)
    Object describing the retry strategy to apply to a Synthetic test.
    rum_settings list(object)
    The RUM data collection settings for the Synthetic browser test.
    schedulings list(object)
    Object containing timeframes and timezone used for advanced scheduling.
    tick_every number
    How often the test should run (in seconds).
    acceptSelfSigned Boolean
    For SSL tests, whether or not the test should allow self signed certificates.
    allowInsecure Boolean
    Allows loading insecure content for a request in an API test or in a multistep API test step.
    blockedRequestPatterns List<String>
    Blocked URL patterns. Requests made to URLs matching any of the patterns listed here will be blocked.
    captureNetworkPayloads Boolean
    Capture HTTP request/response headers and bodies for Fetch/XHR calls made during browser tests.
    checkCertificateRevocation Boolean
    For SSL tests, whether or not the test should fail on revoked certificate in stapled OCSP.
    cis List<GetSyntheticsTestOptionsListCi>
    CI/CD options for a Synthetic test.
    disableAiaIntermediateFetching Boolean
    For SSL tests, whether or not the test should disable fetching intermediate certificates from AIA.
    disableCors Boolean
    Disable Cross-Origin Resource Sharing for browser tests.
    disableCsp Boolean
    Disable Content Security Policy for browser tests.
    followRedirects Boolean
    Determines whether or not the API HTTP test should follow redirects.
    httpVersion String
    HTTP version to use for an HTTP request in an API test or step.
    ignoreCertificateValidation Boolean
    Ignore server certificate error for SSL tests.
    ignoreServerCertificateError Boolean
    Ignore server certificate error for browser tests.
    initialNavigationTimeout Integer
    Timeout before declaring the initial step as failed (in seconds) for browser tests.
    minFailureDuration Integer
    Minimum amount of time in failure required to trigger an alert (in seconds).
    minLocationFailed Integer
    Minimum number of locations in failure required to trigger an alert.
    monitorName String
    The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
    monitorOptions List<GetSyntheticsTestOptionsListMonitorOption>
    Object containing the options for a Synthetic test as a monitor (for example, renotification).
    monitorPriority Integer
    Integer from 1 (high) to 5 (low) indicating alert severity.
    noScreenshot Boolean
    Prevents saving screenshots of the steps.
    restrictedRoles List<String>
    A list of role identifiers pulled from the Roles API to restrict read and write access. Included for parity with the datadog.SyntheticsTest resource.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    retries List<GetSyntheticsTestOptionsListRetry>
    Object describing the retry strategy to apply to a Synthetic test.
    rumSettings List<GetSyntheticsTestOptionsListRumSetting>
    The RUM data collection settings for the Synthetic browser test.
    schedulings List<GetSyntheticsTestOptionsListScheduling>
    Object containing timeframes and timezone used for advanced scheduling.
    tickEvery Integer
    How often the test should run (in seconds).
    acceptSelfSigned boolean
    For SSL tests, whether or not the test should allow self signed certificates.
    allowInsecure boolean
    Allows loading insecure content for a request in an API test or in a multistep API test step.
    blockedRequestPatterns string[]
    Blocked URL patterns. Requests made to URLs matching any of the patterns listed here will be blocked.
    captureNetworkPayloads boolean
    Capture HTTP request/response headers and bodies for Fetch/XHR calls made during browser tests.
    checkCertificateRevocation boolean
    For SSL tests, whether or not the test should fail on revoked certificate in stapled OCSP.
    cis GetSyntheticsTestOptionsListCi[]
    CI/CD options for a Synthetic test.
    disableAiaIntermediateFetching boolean
    For SSL tests, whether or not the test should disable fetching intermediate certificates from AIA.
    disableCors boolean
    Disable Cross-Origin Resource Sharing for browser tests.
    disableCsp boolean
    Disable Content Security Policy for browser tests.
    followRedirects boolean
    Determines whether or not the API HTTP test should follow redirects.
    httpVersion string
    HTTP version to use for an HTTP request in an API test or step.
    ignoreCertificateValidation boolean
    Ignore server certificate error for SSL tests.
    ignoreServerCertificateError boolean
    Ignore server certificate error for browser tests.
    initialNavigationTimeout number
    Timeout before declaring the initial step as failed (in seconds) for browser tests.
    minFailureDuration number
    Minimum amount of time in failure required to trigger an alert (in seconds).
    minLocationFailed number
    Minimum number of locations in failure required to trigger an alert.
    monitorName string
    The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
    monitorOptions GetSyntheticsTestOptionsListMonitorOption[]
    Object containing the options for a Synthetic test as a monitor (for example, renotification).
    monitorPriority number
    Integer from 1 (high) to 5 (low) indicating alert severity.
    noScreenshot boolean
    Prevents saving screenshots of the steps.
    restrictedRoles string[]
    A list of role identifiers pulled from the Roles API to restrict read and write access. Included for parity with the datadog.SyntheticsTest resource.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    retries GetSyntheticsTestOptionsListRetry[]
    Object describing the retry strategy to apply to a Synthetic test.
    rumSettings GetSyntheticsTestOptionsListRumSetting[]
    The RUM data collection settings for the Synthetic browser test.
    schedulings GetSyntheticsTestOptionsListScheduling[]
    Object containing timeframes and timezone used for advanced scheduling.
    tickEvery number
    How often the test should run (in seconds).
    accept_self_signed bool
    For SSL tests, whether or not the test should allow self signed certificates.
    allow_insecure bool
    Allows loading insecure content for a request in an API test or in a multistep API test step.
    blocked_request_patterns Sequence[str]
    Blocked URL patterns. Requests made to URLs matching any of the patterns listed here will be blocked.
    capture_network_payloads bool
    Capture HTTP request/response headers and bodies for Fetch/XHR calls made during browser tests.
    check_certificate_revocation bool
    For SSL tests, whether or not the test should fail on revoked certificate in stapled OCSP.
    cis Sequence[GetSyntheticsTestOptionsListCi]
    CI/CD options for a Synthetic test.
    disable_aia_intermediate_fetching bool
    For SSL tests, whether or not the test should disable fetching intermediate certificates from AIA.
    disable_cors bool
    Disable Cross-Origin Resource Sharing for browser tests.
    disable_csp bool
    Disable Content Security Policy for browser tests.
    follow_redirects bool
    Determines whether or not the API HTTP test should follow redirects.
    http_version str
    HTTP version to use for an HTTP request in an API test or step.
    ignore_certificate_validation bool
    Ignore server certificate error for SSL tests.
    ignore_server_certificate_error bool
    Ignore server certificate error for browser tests.
    initial_navigation_timeout int
    Timeout before declaring the initial step as failed (in seconds) for browser tests.
    min_failure_duration int
    Minimum amount of time in failure required to trigger an alert (in seconds).
    min_location_failed int
    Minimum number of locations in failure required to trigger an alert.
    monitor_name str
    The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
    monitor_options Sequence[GetSyntheticsTestOptionsListMonitorOption]
    Object containing the options for a Synthetic test as a monitor (for example, renotification).
    monitor_priority int
    Integer from 1 (high) to 5 (low) indicating alert severity.
    no_screenshot bool
    Prevents saving screenshots of the steps.
    restricted_roles Sequence[str]
    A list of role identifiers pulled from the Roles API to restrict read and write access. Included for parity with the datadog.SyntheticsTest resource.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    retries Sequence[GetSyntheticsTestOptionsListRetry]
    Object describing the retry strategy to apply to a Synthetic test.
    rum_settings Sequence[GetSyntheticsTestOptionsListRumSetting]
    The RUM data collection settings for the Synthetic browser test.
    schedulings Sequence[GetSyntheticsTestOptionsListScheduling]
    Object containing timeframes and timezone used for advanced scheduling.
    tick_every int
    How often the test should run (in seconds).
    acceptSelfSigned Boolean
    For SSL tests, whether or not the test should allow self signed certificates.
    allowInsecure Boolean
    Allows loading insecure content for a request in an API test or in a multistep API test step.
    blockedRequestPatterns List<String>
    Blocked URL patterns. Requests made to URLs matching any of the patterns listed here will be blocked.
    captureNetworkPayloads Boolean
    Capture HTTP request/response headers and bodies for Fetch/XHR calls made during browser tests.
    checkCertificateRevocation Boolean
    For SSL tests, whether or not the test should fail on revoked certificate in stapled OCSP.
    cis List<Property Map>
    CI/CD options for a Synthetic test.
    disableAiaIntermediateFetching Boolean
    For SSL tests, whether or not the test should disable fetching intermediate certificates from AIA.
    disableCors Boolean
    Disable Cross-Origin Resource Sharing for browser tests.
    disableCsp Boolean
    Disable Content Security Policy for browser tests.
    followRedirects Boolean
    Determines whether or not the API HTTP test should follow redirects.
    httpVersion String
    HTTP version to use for an HTTP request in an API test or step.
    ignoreCertificateValidation Boolean
    Ignore server certificate error for SSL tests.
    ignoreServerCertificateError Boolean
    Ignore server certificate error for browser tests.
    initialNavigationTimeout Number
    Timeout before declaring the initial step as failed (in seconds) for browser tests.
    minFailureDuration Number
    Minimum amount of time in failure required to trigger an alert (in seconds).
    minLocationFailed Number
    Minimum number of locations in failure required to trigger an alert.
    monitorName String
    The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
    monitorOptions List<Property Map>
    Object containing the options for a Synthetic test as a monitor (for example, renotification).
    monitorPriority Number
    Integer from 1 (high) to 5 (low) indicating alert severity.
    noScreenshot Boolean
    Prevents saving screenshots of the steps.
    restrictedRoles List<String>
    A list of role identifiers pulled from the Roles API to restrict read and write access. Included for parity with the datadog.SyntheticsTest resource.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    retries List<Property Map>
    Object describing the retry strategy to apply to a Synthetic test.
    rumSettings List<Property Map>
    The RUM data collection settings for the Synthetic browser test.
    schedulings List<Property Map>
    Object containing timeframes and timezone used for advanced scheduling.
    tickEvery Number
    How often the test should run (in seconds).

    GetSyntheticsTestOptionsListCi

    ExecutionRule string
    Execution rule for a Synthetics test.
    ExecutionRule string
    Execution rule for a Synthetics test.
    execution_rule string
    Execution rule for a Synthetics test.
    executionRule String
    Execution rule for a Synthetics test.
    executionRule string
    Execution rule for a Synthetics test.
    execution_rule str
    Execution rule for a Synthetics test.
    executionRule String
    Execution rule for a Synthetics test.

    GetSyntheticsTestOptionsListMonitorOption

    EscalationMessage string
    A message to include with a re-notification.
    NotificationPresetName string
    The name of the preset for the notification for the monitor.
    RenotifyInterval int
    Specify a renotification frequency in minutes.
    RenotifyOccurrences int
    The number of times a monitor renotifies. It can only be set if renotifyInterval is set.
    EscalationMessage string
    A message to include with a re-notification.
    NotificationPresetName string
    The name of the preset for the notification for the monitor.
    RenotifyInterval int
    Specify a renotification frequency in minutes.
    RenotifyOccurrences int
    The number of times a monitor renotifies. It can only be set if renotifyInterval is set.
    escalation_message string
    A message to include with a re-notification.
    notification_preset_name string
    The name of the preset for the notification for the monitor.
    renotify_interval number
    Specify a renotification frequency in minutes.
    renotify_occurrences number
    The number of times a monitor renotifies. It can only be set if renotifyInterval is set.
    escalationMessage String
    A message to include with a re-notification.
    notificationPresetName String
    The name of the preset for the notification for the monitor.
    renotifyInterval Integer
    Specify a renotification frequency in minutes.
    renotifyOccurrences Integer
    The number of times a monitor renotifies. It can only be set if renotifyInterval is set.
    escalationMessage string
    A message to include with a re-notification.
    notificationPresetName string
    The name of the preset for the notification for the monitor.
    renotifyInterval number
    Specify a renotification frequency in minutes.
    renotifyOccurrences number
    The number of times a monitor renotifies. It can only be set if renotifyInterval is set.
    escalation_message str
    A message to include with a re-notification.
    notification_preset_name str
    The name of the preset for the notification for the monitor.
    renotify_interval int
    Specify a renotification frequency in minutes.
    renotify_occurrences int
    The number of times a monitor renotifies. It can only be set if renotifyInterval is set.
    escalationMessage String
    A message to include with a re-notification.
    notificationPresetName String
    The name of the preset for the notification for the monitor.
    renotifyInterval Number
    Specify a renotification frequency in minutes.
    renotifyOccurrences Number
    The number of times a monitor renotifies. It can only be set if renotifyInterval is set.

    GetSyntheticsTestOptionsListRetry

    Count int
    Number of retries needed to consider a location as failed before sending a notification alert.
    Interval int
    Interval between a failed test and the next retry in milliseconds.
    Count int
    Number of retries needed to consider a location as failed before sending a notification alert.
    Interval int
    Interval between a failed test and the next retry in milliseconds.
    count number
    Number of retries needed to consider a location as failed before sending a notification alert.
    interval number
    Interval between a failed test and the next retry in milliseconds.
    count Integer
    Number of retries needed to consider a location as failed before sending a notification alert.
    interval Integer
    Interval between a failed test and the next retry in milliseconds.
    count number
    Number of retries needed to consider a location as failed before sending a notification alert.
    interval number
    Interval between a failed test and the next retry in milliseconds.
    count int
    Number of retries needed to consider a location as failed before sending a notification alert.
    interval int
    Interval between a failed test and the next retry in milliseconds.
    count Number
    Number of retries needed to consider a location as failed before sending a notification alert.
    interval Number
    Interval between a failed test and the next retry in milliseconds.

    GetSyntheticsTestOptionsListRumSetting

    ApplicationId string
    RUM application ID used to collect RUM data for the browser test.
    ClientTokenId int
    RUM application API key ID used to collect RUM data for the browser test.
    IsEnabled bool
    Determines whether RUM data is collected during test runs.
    ApplicationId string
    RUM application ID used to collect RUM data for the browser test.
    ClientTokenId int
    RUM application API key ID used to collect RUM data for the browser test.
    IsEnabled bool
    Determines whether RUM data is collected during test runs.
    application_id string
    RUM application ID used to collect RUM data for the browser test.
    client_token_id number
    RUM application API key ID used to collect RUM data for the browser test.
    is_enabled bool
    Determines whether RUM data is collected during test runs.
    applicationId String
    RUM application ID used to collect RUM data for the browser test.
    clientTokenId Integer
    RUM application API key ID used to collect RUM data for the browser test.
    isEnabled Boolean
    Determines whether RUM data is collected during test runs.
    applicationId string
    RUM application ID used to collect RUM data for the browser test.
    clientTokenId number
    RUM application API key ID used to collect RUM data for the browser test.
    isEnabled boolean
    Determines whether RUM data is collected during test runs.
    application_id str
    RUM application ID used to collect RUM data for the browser test.
    client_token_id int
    RUM application API key ID used to collect RUM data for the browser test.
    is_enabled bool
    Determines whether RUM data is collected during test runs.
    applicationId String
    RUM application ID used to collect RUM data for the browser test.
    clientTokenId Number
    RUM application API key ID used to collect RUM data for the browser test.
    isEnabled Boolean
    Determines whether RUM data is collected during test runs.

    GetSyntheticsTestOptionsListScheduling

    Timeframes List<GetSyntheticsTestOptionsListSchedulingTimeframe>
    Array containing objects describing the scheduling pattern to apply to each day.
    Timezone string
    Timezone in which the timeframe is based.
    Timeframes []GetSyntheticsTestOptionsListSchedulingTimeframe
    Array containing objects describing the scheduling pattern to apply to each day.
    Timezone string
    Timezone in which the timeframe is based.
    timeframes list(object)
    Array containing objects describing the scheduling pattern to apply to each day.
    timezone string
    Timezone in which the timeframe is based.
    timeframes List<GetSyntheticsTestOptionsListSchedulingTimeframe>
    Array containing objects describing the scheduling pattern to apply to each day.
    timezone String
    Timezone in which the timeframe is based.
    timeframes GetSyntheticsTestOptionsListSchedulingTimeframe[]
    Array containing objects describing the scheduling pattern to apply to each day.
    timezone string
    Timezone in which the timeframe is based.
    timeframes Sequence[GetSyntheticsTestOptionsListSchedulingTimeframe]
    Array containing objects describing the scheduling pattern to apply to each day.
    timezone str
    Timezone in which the timeframe is based.
    timeframes List<Property Map>
    Array containing objects describing the scheduling pattern to apply to each day.
    timezone String
    Timezone in which the timeframe is based.

    GetSyntheticsTestOptionsListSchedulingTimeframe

    Day int
    Number representing the day of the week.
    From string
    The hour of the day on which scheduling starts.
    To string
    The hour of the day on which scheduling ends.
    Day int
    Number representing the day of the week.
    From string
    The hour of the day on which scheduling starts.
    To string
    The hour of the day on which scheduling ends.
    day number
    Number representing the day of the week.
    from string
    The hour of the day on which scheduling starts.
    to string
    The hour of the day on which scheduling ends.
    day Integer
    Number representing the day of the week.
    from String
    The hour of the day on which scheduling starts.
    to String
    The hour of the day on which scheduling ends.
    day number
    Number representing the day of the week.
    from string
    The hour of the day on which scheduling starts.
    to string
    The hour of the day on which scheduling ends.
    day int
    Number representing the day of the week.
    from_ str
    The hour of the day on which scheduling starts.
    to str
    The hour of the day on which scheduling ends.
    day Number
    Number representing the day of the week.
    from String
    The hour of the day on which scheduling starts.
    to String
    The hour of the day on which scheduling ends.

    Package Details

    Repository
    Datadog pulumi/pulumi-datadog
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the datadog Terraform Provider.
    datadog logo
    Viewing docs for Datadog v5.11.0
    published on Tuesday, Sep 15, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-datadog

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial