Docs
Packagesdatadog.SyntheticsTest
Explore with Pulumi AI
Provides a Datadog synthetics test resource. This can be used to create and manage Datadog synthetics test.
Warning
Starting from version 3.1.0+, the direct usage of global variables in the configuration is deprecated, in favor of
local variables of type global. As an example, if you were previously using {{ GLOBAL_VAR }} directly in your
configuration, add a config_variable of type global with the id matching the id of the global variable GLOBAL_VAR, which can be found in the Synthetics UI or from the output of the datadog.SyntheticsGlobalVariable resource. The name can be chosen freely.
In practice, it means going from (simplified configuration):
import * as pulumi from "@pulumi/pulumi";
import pulumi
using System.Collections.Generic;
using System.Linq;
using Pulumi;
return await Deployment.RunAsync(() =>
{
});
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import java.util.List;
import java.util.ArrayList;
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) {
}
}
{}
to
import * as pulumi from "@pulumi/pulumi";
import pulumi
using System.Collections.Generic;
using System.Linq;
using Pulumi;
return await Deployment.RunAsync(() =>
{
});
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import java.util.List;
import java.util.ArrayList;
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) {
}
}
{}
which you can now use in your request definition:
import * as pulumi from "@pulumi/pulumi";
import pulumi
using System.Collections.Generic;
using System.Linq;
using Pulumi;
return await Deployment.RunAsync(() =>
{
});
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import java.util.List;
import java.util.ArrayList;
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) {
}
}
{}
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Datadog = Pulumi.Datadog;
return await Deployment.RunAsync(() =>
{
// Example Usage (Synthetics API test)
// Create a new Datadog Synthetics API/HTTP test on https://www.example.org
var testApi = new Datadog.SyntheticsTest("testApi", new()
{
Assertions = new[]
{
new Datadog.Inputs.SyntheticsTestAssertionArgs
{
Operator = "is",
Target = "200",
Type = "statusCode",
},
},
Locations = new[]
{
"aws:eu-central-1",
},
Message = "Notify @pagerduty",
Name = "An API test on example.org",
OptionsList = new Datadog.Inputs.SyntheticsTestOptionsListArgs
{
MonitorOptions = new Datadog.Inputs.SyntheticsTestOptionsListMonitorOptionsArgs
{
RenotifyInterval = 120,
},
Retry = new Datadog.Inputs.SyntheticsTestOptionsListRetryArgs
{
Count = 2,
Interval = 300,
},
TickEvery = 900,
},
RequestDefinition = new Datadog.Inputs.SyntheticsTestRequestDefinitionArgs
{
Method = "GET",
Url = "https://www.example.org",
},
RequestHeaders =
{
{ "Authentication", "Token: 1234566789" },
{ "Content-Type", "application/json" },
},
Status = "live",
Subtype = "http",
Tags = new[]
{
"foo:bar",
"foo",
"env:test",
},
Type = "api",
});
// Example Usage (Synthetics SSL test)
// Create a new Datadog Synthetics API/SSL test on example.org
var testSsl = new Datadog.SyntheticsTest("testSsl", new()
{
Assertions = new[]
{
new Datadog.Inputs.SyntheticsTestAssertionArgs
{
Operator = "isInMoreThan",
Target = "30",
Type = "certificate",
},
},
Locations = new[]
{
"aws:eu-central-1",
},
Message = "Notify @pagerduty",
Name = "An API test on example.org",
OptionsList = new Datadog.Inputs.SyntheticsTestOptionsListArgs
{
AcceptSelfSigned = true,
TickEvery = 900,
},
RequestDefinition = new Datadog.Inputs.SyntheticsTestRequestDefinitionArgs
{
Host = "example.org",
Port = 443,
},
Status = "live",
Subtype = "ssl",
Tags = new[]
{
"foo:bar",
"foo",
"env:test",
},
Type = "api",
});
// Example Usage (Synthetics TCP test)
// Create a new Datadog Synthetics API/TCP test on example.org
var testTcp = new Datadog.SyntheticsTest("testTcp", new()
{
Assertions = new[]
{
new Datadog.Inputs.SyntheticsTestAssertionArgs
{
Operator = "lessThan",
Target = "2000",
Type = "responseTime",
},
},
ConfigVariables = new[]
{
new Datadog.Inputs.SyntheticsTestConfigVariableArgs
{
Id = "76636cd1-82e2-4aeb-9cfe-51366a8198a2",
Name = "MY_GLOBAL_VAR",
Type = "global",
},
},
Locations = new[]
{
"aws:eu-central-1",
},
Message = "Notify @pagerduty",
Name = "An API test on example.org",
OptionsList = new Datadog.Inputs.SyntheticsTestOptionsListArgs
{
TickEvery = 900,
},
RequestDefinition = new Datadog.Inputs.SyntheticsTestRequestDefinitionArgs
{
Host = "example.org",
Port = 443,
},
Status = "live",
Subtype = "tcp",
Tags = new[]
{
"foo:bar",
"foo",
"env:test",
},
Type = "api",
});
// Example Usage (Synthetics DNS test)
// Create a new Datadog Synthetics API/DNS test on example.org
var testDns = new Datadog.SyntheticsTest("testDns", new()
{
Assertions = new[]
{
new Datadog.Inputs.SyntheticsTestAssertionArgs
{
Operator = "is",
Property = "A",
Target = "0.0.0.0",
Type = "recordSome",
},
},
Locations = new[]
{
"aws:eu-central-1",
},
Message = "Notify @pagerduty",
Name = "An API test on example.org",
OptionsList = new Datadog.Inputs.SyntheticsTestOptionsListArgs
{
TickEvery = 900,
},
RequestDefinition = new Datadog.Inputs.SyntheticsTestRequestDefinitionArgs
{
Host = "example.org",
},
Status = "live",
Subtype = "dns",
Tags = new[]
{
"foo:bar",
"foo",
"env:test",
},
Type = "api",
});
// Example Usage (Synthetics Multistep API test)
// Create a new Datadog Synthetics Multistep API test
var test = new Datadog.SyntheticsTest("test", new()
{
ApiSteps = new[]
{
new Datadog.Inputs.SyntheticsTestApiStepArgs
{
Assertions = new[]
{
new Datadog.Inputs.SyntheticsTestApiStepAssertionArgs
{
Operator = "is",
Target = "200",
Type = "statusCode",
},
},
Name = "An API test on example.org",
RequestDefinition = new Datadog.Inputs.SyntheticsTestApiStepRequestDefinitionArgs
{
Method = "GET",
Url = "https://example.org",
},
RequestHeaders =
{
{ "Authentication", "Token: 1234566789" },
{ "Content-Type", "application/json" },
},
Subtype = "http",
},
new Datadog.Inputs.SyntheticsTestApiStepArgs
{
Assertions = new[]
{
new Datadog.Inputs.SyntheticsTestApiStepAssertionArgs
{
Operator = "is",
Target = "200",
Type = "statusCode",
},
},
Name = "An API test on example.org",
RequestDefinition = new Datadog.Inputs.SyntheticsTestApiStepRequestDefinitionArgs
{
Method = "GET",
Url = "http://example.org",
},
Subtype = "http",
},
},
Locations = new[]
{
"aws:eu-central-1",
},
Name = "Multistep API test",
OptionsList = new Datadog.Inputs.SyntheticsTestOptionsListArgs
{
AcceptSelfSigned = true,
TickEvery = 900,
},
Status = "live",
Subtype = "multi",
Type = "api",
});
// Example Usage (Synthetics Browser test)
// Create a new Datadog Synthetics Browser test starting on https://www.example.org
var testBrowser = new Datadog.SyntheticsTest("testBrowser", new()
{
BrowserSteps = new[]
{
new Datadog.Inputs.SyntheticsTestBrowserStepArgs
{
Name = "Check current url",
Params = new Datadog.Inputs.SyntheticsTestBrowserStepParamsArgs
{
Check = "contains",
Value = "datadoghq",
},
Type = "assertCurrentUrl",
},
},
BrowserVariables = new[]
{
new Datadog.Inputs.SyntheticsTestBrowserVariableArgs
{
Example = "597",
Name = "MY_PATTERN_VAR",
Pattern = "{{numeric(3)}}",
Type = "text",
},
new Datadog.Inputs.SyntheticsTestBrowserVariableArgs
{
Example = "jd8-afe-ydv.4546132139@synthetics.dtdg.co",
Name = "MY_EMAIL_VAR",
Pattern = "jd8-afe-ydv.{{ numeric(10) }}@synthetics.dtdg.co",
Type = "email",
},
new Datadog.Inputs.SyntheticsTestBrowserVariableArgs
{
Id = "76636cd1-82e2-4aeb-9cfe-51366a8198a2",
Name = "MY_GLOBAL_VAR",
Type = "global",
},
},
DeviceIds = new[]
{
"laptop_large",
},
Locations = new[]
{
"aws:eu-central-1",
},
Message = "Notify @qa",
Name = "A Browser test on example.org",
OptionsList = new Datadog.Inputs.SyntheticsTestOptionsListArgs
{
TickEvery = 3600,
},
RequestDefinition = new Datadog.Inputs.SyntheticsTestRequestDefinitionArgs
{
Method = "GET",
Url = "https://app.datadoghq.com",
},
Status = "paused",
Tags = new[] {},
Type = "browser",
});
});
package main
import (
"github.com/pulumi/pulumi-datadog/sdk/v4/go/datadog"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := datadog.NewSyntheticsTest(ctx, "testApi", &datadog.SyntheticsTestArgs{
Assertions: datadog.SyntheticsTestAssertionArray{
&datadog.SyntheticsTestAssertionArgs{
Operator: pulumi.String("is"),
Target: pulumi.String("200"),
Type: pulumi.String("statusCode"),
},
},
Locations: pulumi.StringArray{
pulumi.String("aws:eu-central-1"),
},
Message: pulumi.String("Notify @pagerduty"),
Name: pulumi.String("An API test on example.org"),
OptionsList: &datadog.SyntheticsTestOptionsListArgs{
MonitorOptions: &datadog.SyntheticsTestOptionsListMonitorOptionsArgs{
RenotifyInterval: pulumi.Int(120),
},
Retry: &datadog.SyntheticsTestOptionsListRetryArgs{
Count: pulumi.Int(2),
Interval: pulumi.Int(300),
},
TickEvery: pulumi.Int(900),
},
RequestDefinition: &datadog.SyntheticsTestRequestDefinitionArgs{
Method: pulumi.String("GET"),
Url: pulumi.String("https://www.example.org"),
},
RequestHeaders: pulumi.AnyMap{
"Authentication": pulumi.Any("Token: 1234566789"),
"Content-Type": pulumi.Any("application/json"),
},
Status: pulumi.String("live"),
Subtype: pulumi.String("http"),
Tags: pulumi.StringArray{
pulumi.String("foo:bar"),
pulumi.String("foo"),
pulumi.String("env:test"),
},
Type: pulumi.String("api"),
})
if err != nil {
return err
}
_, err = datadog.NewSyntheticsTest(ctx, "testSsl", &datadog.SyntheticsTestArgs{
Assertions: datadog.SyntheticsTestAssertionArray{
&datadog.SyntheticsTestAssertionArgs{
Operator: pulumi.String("isInMoreThan"),
Target: pulumi.String("30"),
Type: pulumi.String("certificate"),
},
},
Locations: pulumi.StringArray{
pulumi.String("aws:eu-central-1"),
},
Message: pulumi.String("Notify @pagerduty"),
Name: pulumi.String("An API test on example.org"),
OptionsList: &datadog.SyntheticsTestOptionsListArgs{
AcceptSelfSigned: pulumi.Bool(true),
TickEvery: pulumi.Int(900),
},
RequestDefinition: &datadog.SyntheticsTestRequestDefinitionArgs{
Host: pulumi.String("example.org"),
Port: pulumi.Int(443),
},
Status: pulumi.String("live"),
Subtype: pulumi.String("ssl"),
Tags: pulumi.StringArray{
pulumi.String("foo:bar"),
pulumi.String("foo"),
pulumi.String("env:test"),
},
Type: pulumi.String("api"),
})
if err != nil {
return err
}
_, err = datadog.NewSyntheticsTest(ctx, "testTcp", &datadog.SyntheticsTestArgs{
Assertions: datadog.SyntheticsTestAssertionArray{
&datadog.SyntheticsTestAssertionArgs{
Operator: pulumi.String("lessThan"),
Target: pulumi.String("2000"),
Type: pulumi.String("responseTime"),
},
},
ConfigVariables: datadog.SyntheticsTestConfigVariableArray{
&datadog.SyntheticsTestConfigVariableArgs{
Id: pulumi.String("76636cd1-82e2-4aeb-9cfe-51366a8198a2"),
Name: pulumi.String("MY_GLOBAL_VAR"),
Type: pulumi.String("global"),
},
},
Locations: pulumi.StringArray{
pulumi.String("aws:eu-central-1"),
},
Message: pulumi.String("Notify @pagerduty"),
Name: pulumi.String("An API test on example.org"),
OptionsList: &datadog.SyntheticsTestOptionsListArgs{
TickEvery: pulumi.Int(900),
},
RequestDefinition: &datadog.SyntheticsTestRequestDefinitionArgs{
Host: pulumi.String("example.org"),
Port: pulumi.Int(443),
},
Status: pulumi.String("live"),
Subtype: pulumi.String("tcp"),
Tags: pulumi.StringArray{
pulumi.String("foo:bar"),
pulumi.String("foo"),
pulumi.String("env:test"),
},
Type: pulumi.String("api"),
})
if err != nil {
return err
}
_, err = datadog.NewSyntheticsTest(ctx, "testDns", &datadog.SyntheticsTestArgs{
Assertions: datadog.SyntheticsTestAssertionArray{
&datadog.SyntheticsTestAssertionArgs{
Operator: pulumi.String("is"),
Property: pulumi.String("A"),
Target: pulumi.String("0.0.0.0"),
Type: pulumi.String("recordSome"),
},
},
Locations: pulumi.StringArray{
pulumi.String("aws:eu-central-1"),
},
Message: pulumi.String("Notify @pagerduty"),
Name: pulumi.String("An API test on example.org"),
OptionsList: &datadog.SyntheticsTestOptionsListArgs{
TickEvery: pulumi.Int(900),
},
RequestDefinition: &datadog.SyntheticsTestRequestDefinitionArgs{
Host: pulumi.String("example.org"),
},
Status: pulumi.String("live"),
Subtype: pulumi.String("dns"),
Tags: pulumi.StringArray{
pulumi.String("foo:bar"),
pulumi.String("foo"),
pulumi.String("env:test"),
},
Type: pulumi.String("api"),
})
if err != nil {
return err
}
_, err = datadog.NewSyntheticsTest(ctx, "test", &datadog.SyntheticsTestArgs{
ApiSteps: datadog.SyntheticsTestApiStepArray{
&datadog.SyntheticsTestApiStepArgs{
Assertions: datadog.SyntheticsTestApiStepAssertionArray{
&datadog.SyntheticsTestApiStepAssertionArgs{
Operator: pulumi.String("is"),
Target: pulumi.String("200"),
Type: pulumi.String("statusCode"),
},
},
Name: pulumi.String("An API test on example.org"),
RequestDefinition: &datadog.SyntheticsTestApiStepRequestDefinitionArgs{
Method: pulumi.String("GET"),
Url: pulumi.String("https://example.org"),
},
RequestHeaders: pulumi.AnyMap{
"Authentication": pulumi.Any("Token: 1234566789"),
"Content-Type": pulumi.Any("application/json"),
},
Subtype: pulumi.String("http"),
},
&datadog.SyntheticsTestApiStepArgs{
Assertions: datadog.SyntheticsTestApiStepAssertionArray{
&datadog.SyntheticsTestApiStepAssertionArgs{
Operator: pulumi.String("is"),
Target: pulumi.String("200"),
Type: pulumi.String("statusCode"),
},
},
Name: pulumi.String("An API test on example.org"),
RequestDefinition: &datadog.SyntheticsTestApiStepRequestDefinitionArgs{
Method: pulumi.String("GET"),
Url: pulumi.String("http://example.org"),
},
Subtype: pulumi.String("http"),
},
},
Locations: pulumi.StringArray{
pulumi.String("aws:eu-central-1"),
},
Name: pulumi.String("Multistep API test"),
OptionsList: &datadog.SyntheticsTestOptionsListArgs{
AcceptSelfSigned: pulumi.Bool(true),
TickEvery: pulumi.Int(900),
},
Status: pulumi.String("live"),
Subtype: pulumi.String("multi"),
Type: pulumi.String("api"),
})
if err != nil {
return err
}
_, err = datadog.NewSyntheticsTest(ctx, "testBrowser", &datadog.SyntheticsTestArgs{
BrowserSteps: datadog.SyntheticsTestBrowserStepArray{
&datadog.SyntheticsTestBrowserStepArgs{
Name: pulumi.String("Check current url"),
Params: &datadog.SyntheticsTestBrowserStepParamsArgs{
Check: pulumi.String("contains"),
Value: pulumi.String("datadoghq"),
},
Type: pulumi.String("assertCurrentUrl"),
},
},
BrowserVariables: datadog.SyntheticsTestBrowserVariableArray{
&datadog.SyntheticsTestBrowserVariableArgs{
Example: pulumi.String("597"),
Name: pulumi.String("MY_PATTERN_VAR"),
Pattern: pulumi.String("{{numeric(3)}}"),
Type: pulumi.String("text"),
},
&datadog.SyntheticsTestBrowserVariableArgs{
Example: pulumi.String("jd8-afe-ydv.4546132139@synthetics.dtdg.co"),
Name: pulumi.String("MY_EMAIL_VAR"),
Pattern: pulumi.String("jd8-afe-ydv.{{ numeric(10) }}@synthetics.dtdg.co"),
Type: pulumi.String("email"),
},
&datadog.SyntheticsTestBrowserVariableArgs{
Id: pulumi.String("76636cd1-82e2-4aeb-9cfe-51366a8198a2"),
Name: pulumi.String("MY_GLOBAL_VAR"),
Type: pulumi.String("global"),
},
},
DeviceIds: pulumi.StringArray{
pulumi.String("laptop_large"),
},
Locations: pulumi.StringArray{
pulumi.String("aws:eu-central-1"),
},
Message: pulumi.String("Notify @qa"),
Name: pulumi.String("A Browser test on example.org"),
OptionsList: &datadog.SyntheticsTestOptionsListArgs{
TickEvery: pulumi.Int(3600),
},
RequestDefinition: &datadog.SyntheticsTestRequestDefinitionArgs{
Method: pulumi.String("GET"),
Url: pulumi.String("https://app.datadoghq.com"),
},
Status: pulumi.String("paused"),
Tags: pulumi.StringArray{},
Type: pulumi.String("browser"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.datadog.SyntheticsTest;
import com.pulumi.datadog.SyntheticsTestArgs;
import com.pulumi.datadog.inputs.SyntheticsTestAssertionArgs;
import com.pulumi.datadog.inputs.SyntheticsTestOptionsListArgs;
import com.pulumi.datadog.inputs.SyntheticsTestOptionsListMonitorOptionsArgs;
import com.pulumi.datadog.inputs.SyntheticsTestOptionsListRetryArgs;
import com.pulumi.datadog.inputs.SyntheticsTestRequestDefinitionArgs;
import com.pulumi.datadog.inputs.SyntheticsTestConfigVariableArgs;
import com.pulumi.datadog.inputs.SyntheticsTestApiStepArgs;
import com.pulumi.datadog.inputs.SyntheticsTestApiStepRequestDefinitionArgs;
import com.pulumi.datadog.inputs.SyntheticsTestBrowserStepArgs;
import com.pulumi.datadog.inputs.SyntheticsTestBrowserStepParamsArgs;
import com.pulumi.datadog.inputs.SyntheticsTestBrowserVariableArgs;
import java.util.List;
import java.util.ArrayList;
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) {
var testApi = new SyntheticsTest("testApi", SyntheticsTestArgs.builder()
.assertions(SyntheticsTestAssertionArgs.builder()
.operator("is")
.target("200")
.type("statusCode")
.build())
.locations("aws:eu-central-1")
.message("Notify @pagerduty")
.name("An API test on example.org")
.optionsList(SyntheticsTestOptionsListArgs.builder()
.monitorOptions(SyntheticsTestOptionsListMonitorOptionsArgs.builder()
.renotifyInterval(120)
.build())
.retry(SyntheticsTestOptionsListRetryArgs.builder()
.count(2)
.interval(300)
.build())
.tickEvery(900)
.build())
.requestDefinition(SyntheticsTestRequestDefinitionArgs.builder()
.method("GET")
.url("https://www.example.org")
.build())
.requestHeaders(Map.ofEntries(
Map.entry("Authentication", "Token: 1234566789"),
Map.entry("Content-Type", "application/json")
))
.status("live")
.subtype("http")
.tags(
"foo:bar",
"foo",
"env:test")
.type("api")
.build());
var testSsl = new SyntheticsTest("testSsl", SyntheticsTestArgs.builder()
.assertions(SyntheticsTestAssertionArgs.builder()
.operator("isInMoreThan")
.target(30)
.type("certificate")
.build())
.locations("aws:eu-central-1")
.message("Notify @pagerduty")
.name("An API test on example.org")
.optionsList(SyntheticsTestOptionsListArgs.builder()
.acceptSelfSigned(true)
.tickEvery(900)
.build())
.requestDefinition(SyntheticsTestRequestDefinitionArgs.builder()
.host("example.org")
.port(443)
.build())
.status("live")
.subtype("ssl")
.tags(
"foo:bar",
"foo",
"env:test")
.type("api")
.build());
var testTcp = new SyntheticsTest("testTcp", SyntheticsTestArgs.builder()
.assertions(SyntheticsTestAssertionArgs.builder()
.operator("lessThan")
.target(2000)
.type("responseTime")
.build())
.configVariables(SyntheticsTestConfigVariableArgs.builder()
.id("76636cd1-82e2-4aeb-9cfe-51366a8198a2")
.name("MY_GLOBAL_VAR")
.type("global")
.build())
.locations("aws:eu-central-1")
.message("Notify @pagerduty")
.name("An API test on example.org")
.optionsList(SyntheticsTestOptionsListArgs.builder()
.tickEvery(900)
.build())
.requestDefinition(SyntheticsTestRequestDefinitionArgs.builder()
.host("example.org")
.port(443)
.build())
.status("live")
.subtype("tcp")
.tags(
"foo:bar",
"foo",
"env:test")
.type("api")
.build());
var testDns = new SyntheticsTest("testDns", SyntheticsTestArgs.builder()
.assertions(SyntheticsTestAssertionArgs.builder()
.operator("is")
.property("A")
.target("0.0.0.0")
.type("recordSome")
.build())
.locations("aws:eu-central-1")
.message("Notify @pagerduty")
.name("An API test on example.org")
.optionsList(SyntheticsTestOptionsListArgs.builder()
.tickEvery(900)
.build())
.requestDefinition(SyntheticsTestRequestDefinitionArgs.builder()
.host("example.org")
.build())
.status("live")
.subtype("dns")
.tags(
"foo:bar",
"foo",
"env:test")
.type("api")
.build());
var test = new SyntheticsTest("test", SyntheticsTestArgs.builder()
.apiSteps(
SyntheticsTestApiStepArgs.builder()
.assertions(SyntheticsTestApiStepAssertionArgs.builder()
.operator("is")
.target("200")
.type("statusCode")
.build())
.name("An API test on example.org")
.requestDefinition(SyntheticsTestApiStepRequestDefinitionArgs.builder()
.method("GET")
.url("https://example.org")
.build())
.requestHeaders(Map.ofEntries(
Map.entry("Authentication", "Token: 1234566789"),
Map.entry("Content-Type", "application/json")
))
.subtype("http")
.build(),
SyntheticsTestApiStepArgs.builder()
.assertions(SyntheticsTestApiStepAssertionArgs.builder()
.operator("is")
.target("200")
.type("statusCode")
.build())
.name("An API test on example.org")
.requestDefinition(SyntheticsTestApiStepRequestDefinitionArgs.builder()
.method("GET")
.url("http://example.org")
.build())
.subtype("http")
.build())
.locations("aws:eu-central-1")
.name("Multistep API test")
.optionsList(SyntheticsTestOptionsListArgs.builder()
.acceptSelfSigned(true)
.tickEvery(900)
.build())
.status("live")
.subtype("multi")
.type("api")
.build());
var testBrowser = new SyntheticsTest("testBrowser", SyntheticsTestArgs.builder()
.browserSteps(SyntheticsTestBrowserStepArgs.builder()
.name("Check current url")
.params(SyntheticsTestBrowserStepParamsArgs.builder()
.check("contains")
.value("datadoghq")
.build())
.type("assertCurrentUrl")
.build())
.browserVariables(
SyntheticsTestBrowserVariableArgs.builder()
.example("597")
.name("MY_PATTERN_VAR")
.pattern("{{numeric(3)}}")
.type("text")
.build(),
SyntheticsTestBrowserVariableArgs.builder()
.example("jd8-afe-ydv.4546132139@synthetics.dtdg.co")
.name("MY_EMAIL_VAR")
.pattern("jd8-afe-ydv.{{ numeric(10) }}@synthetics.dtdg.co")
.type("email")
.build(),
SyntheticsTestBrowserVariableArgs.builder()
.id("76636cd1-82e2-4aeb-9cfe-51366a8198a2")
.name("MY_GLOBAL_VAR")
.type("global")
.build())
.deviceIds("laptop_large")
.locations("aws:eu-central-1")
.message("Notify @qa")
.name("A Browser test on example.org")
.optionsList(SyntheticsTestOptionsListArgs.builder()
.tickEvery(3600)
.build())
.requestDefinition(SyntheticsTestRequestDefinitionArgs.builder()
.method("GET")
.url("https://app.datadoghq.com")
.build())
.status("paused")
.tags()
.type("browser")
.build());
}
}
import pulumi
import pulumi_datadog as datadog
# Example Usage (Synthetics API test)
# Create a new Datadog Synthetics API/HTTP test on https://www.example.org
test_api = datadog.SyntheticsTest("testApi",
assertions=[datadog.SyntheticsTestAssertionArgs(
operator="is",
target="200",
type="statusCode",
)],
locations=["aws:eu-central-1"],
message="Notify @pagerduty",
name="An API test on example.org",
options_list=datadog.SyntheticsTestOptionsListArgs(
monitor_options=datadog.SyntheticsTestOptionsListMonitorOptionsArgs(
renotify_interval=120,
),
retry=datadog.SyntheticsTestOptionsListRetryArgs(
count=2,
interval=300,
),
tick_every=900,
),
request_definition=datadog.SyntheticsTestRequestDefinitionArgs(
method="GET",
url="https://www.example.org",
),
request_headers={
"Authentication": "Token: 1234566789",
"Content-Type": "application/json",
},
status="live",
subtype="http",
tags=[
"foo:bar",
"foo",
"env:test",
],
type="api")
# Example Usage (Synthetics SSL test)
# Create a new Datadog Synthetics API/SSL test on example.org
test_ssl = datadog.SyntheticsTest("testSsl",
assertions=[datadog.SyntheticsTestAssertionArgs(
operator="isInMoreThan",
target="30",
type="certificate",
)],
locations=["aws:eu-central-1"],
message="Notify @pagerduty",
name="An API test on example.org",
options_list=datadog.SyntheticsTestOptionsListArgs(
accept_self_signed=True,
tick_every=900,
),
request_definition=datadog.SyntheticsTestRequestDefinitionArgs(
host="example.org",
port=443,
),
status="live",
subtype="ssl",
tags=[
"foo:bar",
"foo",
"env:test",
],
type="api")
# Example Usage (Synthetics TCP test)
# Create a new Datadog Synthetics API/TCP test on example.org
test_tcp = datadog.SyntheticsTest("testTcp",
assertions=[datadog.SyntheticsTestAssertionArgs(
operator="lessThan",
target="2000",
type="responseTime",
)],
config_variables=[datadog.SyntheticsTestConfigVariableArgs(
id="76636cd1-82e2-4aeb-9cfe-51366a8198a2",
name="MY_GLOBAL_VAR",
type="global",
)],
locations=["aws:eu-central-1"],
message="Notify @pagerduty",
name="An API test on example.org",
options_list=datadog.SyntheticsTestOptionsListArgs(
tick_every=900,
),
request_definition=datadog.SyntheticsTestRequestDefinitionArgs(
host="example.org",
port=443,
),
status="live",
subtype="tcp",
tags=[
"foo:bar",
"foo",
"env:test",
],
type="api")
# Example Usage (Synthetics DNS test)
# Create a new Datadog Synthetics API/DNS test on example.org
test_dns = datadog.SyntheticsTest("testDns",
assertions=[datadog.SyntheticsTestAssertionArgs(
operator="is",
property="A",
target="0.0.0.0",
type="recordSome",
)],
locations=["aws:eu-central-1"],
message="Notify @pagerduty",
name="An API test on example.org",
options_list=datadog.SyntheticsTestOptionsListArgs(
tick_every=900,
),
request_definition=datadog.SyntheticsTestRequestDefinitionArgs(
host="example.org",
),
status="live",
subtype="dns",
tags=[
"foo:bar",
"foo",
"env:test",
],
type="api")
# Example Usage (Synthetics Multistep API test)
# Create a new Datadog Synthetics Multistep API test
test = datadog.SyntheticsTest("test",
api_steps=[
datadog.SyntheticsTestApiStepArgs(
assertions=[datadog.SyntheticsTestApiStepAssertionArgs(
operator="is",
target="200",
type="statusCode",
)],
name="An API test on example.org",
request_definition=datadog.SyntheticsTestApiStepRequestDefinitionArgs(
method="GET",
url="https://example.org",
),
request_headers={
"Authentication": "Token: 1234566789",
"Content-Type": "application/json",
},
subtype="http",
),
datadog.SyntheticsTestApiStepArgs(
assertions=[datadog.SyntheticsTestApiStepAssertionArgs(
operator="is",
target="200",
type="statusCode",
)],
name="An API test on example.org",
request_definition=datadog.SyntheticsTestApiStepRequestDefinitionArgs(
method="GET",
url="http://example.org",
),
subtype="http",
),
],
locations=["aws:eu-central-1"],
name="Multistep API test",
options_list=datadog.SyntheticsTestOptionsListArgs(
accept_self_signed=True,
tick_every=900,
),
status="live",
subtype="multi",
type="api")
# Example Usage (Synthetics Browser test)
# Create a new Datadog Synthetics Browser test starting on https://www.example.org
test_browser = datadog.SyntheticsTest("testBrowser",
browser_steps=[datadog.SyntheticsTestBrowserStepArgs(
name="Check current url",
params=datadog.SyntheticsTestBrowserStepParamsArgs(
check="contains",
value="datadoghq",
),
type="assertCurrentUrl",
)],
browser_variables=[
datadog.SyntheticsTestBrowserVariableArgs(
example="597",
name="MY_PATTERN_VAR",
pattern="{{numeric(3)}}",
type="text",
),
datadog.SyntheticsTestBrowserVariableArgs(
example="jd8-afe-ydv.4546132139@synthetics.dtdg.co",
name="MY_EMAIL_VAR",
pattern="jd8-afe-ydv.{{ numeric(10) }}@synthetics.dtdg.co",
type="email",
),
datadog.SyntheticsTestBrowserVariableArgs(
id="76636cd1-82e2-4aeb-9cfe-51366a8198a2",
name="MY_GLOBAL_VAR",
type="global",
),
],
device_ids=["laptop_large"],
locations=["aws:eu-central-1"],
message="Notify @qa",
name="A Browser test on example.org",
options_list=datadog.SyntheticsTestOptionsListArgs(
tick_every=3600,
),
request_definition=datadog.SyntheticsTestRequestDefinitionArgs(
method="GET",
url="https://app.datadoghq.com",
),
status="paused",
tags=[],
type="browser")
import * as pulumi from "@pulumi/pulumi";
import * as datadog from "@pulumi/datadog";
// Example Usage (Synthetics API test)
// Create a new Datadog Synthetics API/HTTP test on https://www.example.org
const testApi = new datadog.SyntheticsTest("testApi", {
assertions: [{
operator: "is",
target: "200",
type: "statusCode",
}],
locations: ["aws:eu-central-1"],
message: "Notify @pagerduty",
name: "An API test on example.org",
optionsList: {
monitorOptions: {
renotifyInterval: 120,
},
retry: {
count: 2,
interval: 300,
},
tickEvery: 900,
},
requestDefinition: {
method: "GET",
url: "https://www.example.org",
},
requestHeaders: {
Authentication: "Token: 1234566789",
"Content-Type": "application/json",
},
status: "live",
subtype: "http",
tags: [
"foo:bar",
"foo",
"env:test",
],
type: "api",
});
// Example Usage (Synthetics SSL test)
// Create a new Datadog Synthetics API/SSL test on example.org
const testSsl = new datadog.SyntheticsTest("testSsl", {
assertions: [{
operator: "isInMoreThan",
target: "30",
type: "certificate",
}],
locations: ["aws:eu-central-1"],
message: "Notify @pagerduty",
name: "An API test on example.org",
optionsList: {
acceptSelfSigned: true,
tickEvery: 900,
},
requestDefinition: {
host: "example.org",
port: 443,
},
status: "live",
subtype: "ssl",
tags: [
"foo:bar",
"foo",
"env:test",
],
type: "api",
});
// Example Usage (Synthetics TCP test)
// Create a new Datadog Synthetics API/TCP test on example.org
const testTcp = new datadog.SyntheticsTest("testTcp", {
assertions: [{
operator: "lessThan",
target: "2000",
type: "responseTime",
}],
configVariables: [{
id: "76636cd1-82e2-4aeb-9cfe-51366a8198a2",
name: "MY_GLOBAL_VAR",
type: "global",
}],
locations: ["aws:eu-central-1"],
message: "Notify @pagerduty",
name: "An API test on example.org",
optionsList: {
tickEvery: 900,
},
requestDefinition: {
host: "example.org",
port: 443,
},
status: "live",
subtype: "tcp",
tags: [
"foo:bar",
"foo",
"env:test",
],
type: "api",
});
// Example Usage (Synthetics DNS test)
// Create a new Datadog Synthetics API/DNS test on example.org
const testDns = new datadog.SyntheticsTest("testDns", {
assertions: [{
operator: "is",
property: "A",
target: "0.0.0.0",
type: "recordSome",
}],
locations: ["aws:eu-central-1"],
message: "Notify @pagerduty",
name: "An API test on example.org",
optionsList: {
tickEvery: 900,
},
requestDefinition: {
host: "example.org",
},
status: "live",
subtype: "dns",
tags: [
"foo:bar",
"foo",
"env:test",
],
type: "api",
});
// Example Usage (Synthetics Multistep API test)
// Create a new Datadog Synthetics Multistep API test
const test = new datadog.SyntheticsTest("test", {
apiSteps: [
{
assertions: [{
operator: "is",
target: "200",
type: "statusCode",
}],
name: "An API test on example.org",
requestDefinition: {
method: "GET",
url: "https://example.org",
},
requestHeaders: {
Authentication: "Token: 1234566789",
"Content-Type": "application/json",
},
subtype: "http",
},
{
assertions: [{
operator: "is",
target: "200",
type: "statusCode",
}],
name: "An API test on example.org",
requestDefinition: {
method: "GET",
url: "http://example.org",
},
subtype: "http",
},
],
locations: ["aws:eu-central-1"],
name: "Multistep API test",
optionsList: {
acceptSelfSigned: true,
tickEvery: 900,
},
status: "live",
subtype: "multi",
type: "api",
});
// Example Usage (Synthetics Browser test)
// Create a new Datadog Synthetics Browser test starting on https://www.example.org
const testBrowser = new datadog.SyntheticsTest("testBrowser", {
browserSteps: [{
name: "Check current url",
params: {
check: "contains",
value: "datadoghq",
},
type: "assertCurrentUrl",
}],
browserVariables: [
{
example: "597",
name: "MY_PATTERN_VAR",
pattern: "{{numeric(3)}}",
type: "text",
},
{
example: "jd8-afe-ydv.4546132139@synthetics.dtdg.co",
name: "MY_EMAIL_VAR",
pattern: "jd8-afe-ydv.{{ numeric(10) }}@synthetics.dtdg.co",
type: "email",
},
{
id: "76636cd1-82e2-4aeb-9cfe-51366a8198a2",
name: "MY_GLOBAL_VAR",
type: "global",
},
],
deviceIds: ["laptop_large"],
locations: ["aws:eu-central-1"],
message: "Notify @qa",
name: "A Browser test on example.org",
optionsList: {
tickEvery: 3600,
},
requestDefinition: {
method: "GET",
url: "https://app.datadoghq.com",
},
status: "paused",
tags: [],
type: "browser",
});
resources:
# Example Usage (Synthetics API test)
# // Create a new Datadog Synthetics API/HTTP test on https://www.example.org
testApi:
type: datadog:SyntheticsTest
properties:
assertions:
- operator: is
target: '200'
type: statusCode
locations:
- aws:eu-central-1
message: Notify @pagerduty
name: An API test on example.org
optionsList:
monitorOptions:
renotifyInterval: 120
retry:
count: 2
interval: 300
tickEvery: 900
requestDefinition:
method: GET
url: https://www.example.org
requestHeaders:
Authentication: 'Token: 1234566789'
Content-Type: application/json
status: live
subtype: http
tags:
- foo:bar
- foo
- env:test
type: api
# Example Usage (Synthetics SSL test)
# // Create a new Datadog Synthetics API/SSL test on example.org
testSsl:
type: datadog:SyntheticsTest
properties:
assertions:
- operator: isInMoreThan
target: 30
type: certificate
locations:
- aws:eu-central-1
message: Notify @pagerduty
name: An API test on example.org
optionsList:
acceptSelfSigned: true
tickEvery: 900
requestDefinition:
host: example.org
port: 443
status: live
subtype: ssl
tags:
- foo:bar
- foo
- env:test
type: api
# Example Usage (Synthetics TCP test)
# // Create a new Datadog Synthetics API/TCP test on example.org
testTcp:
type: datadog:SyntheticsTest
properties:
assertions:
- operator: lessThan
target: 2000
type: responseTime
configVariables:
- id: 76636cd1-82e2-4aeb-9cfe-51366a8198a2
name: MY_GLOBAL_VAR
type: global
locations:
- aws:eu-central-1
message: Notify @pagerduty
name: An API test on example.org
optionsList:
tickEvery: 900
requestDefinition:
host: example.org
port: 443
status: live
subtype: tcp
tags:
- foo:bar
- foo
- env:test
type: api
# Example Usage (Synthetics DNS test)
# // Create a new Datadog Synthetics API/DNS test on example.org
testDns:
type: datadog:SyntheticsTest
properties:
assertions:
- operator: is
property: A
target: 0.0.0.0
type: recordSome
locations:
- aws:eu-central-1
message: Notify @pagerduty
name: An API test on example.org
optionsList:
tickEvery: 900
requestDefinition:
host: example.org
status: live
subtype: dns
tags:
- foo:bar
- foo
- env:test
type: api
# Example Usage (Synthetics Multistep API test)
# // Create a new Datadog Synthetics Multistep API test
test:
type: datadog:SyntheticsTest
properties:
apiSteps:
- assertions:
- operator: is
target: '200'
type: statusCode
name: An API test on example.org
requestDefinition:
method: GET
url: https://example.org
requestHeaders:
Authentication: 'Token: 1234566789'
Content-Type: application/json
subtype: http
- assertions:
- operator: is
target: '200'
type: statusCode
name: An API test on example.org
requestDefinition:
method: GET
url: http://example.org
subtype: http
locations:
- aws:eu-central-1
name: Multistep API test
optionsList:
acceptSelfSigned: true
tickEvery: 900
status: live
subtype: multi
type: api
# Example Usage (Synthetics Browser test)
# // Create a new Datadog Synthetics Browser test starting on https://www.example.org
testBrowser:
type: datadog:SyntheticsTest
properties:
browserSteps:
- name: Check current url
params:
check: contains
value: datadoghq
type: assertCurrentUrl
browserVariables:
- example: '597'
name: MY_PATTERN_VAR
pattern: '{{numeric(3)}}'
type: text
- example: jd8-afe-ydv.4546132139@synthetics.dtdg.co
name: MY_EMAIL_VAR
pattern: jd8-afe-ydv.{{ numeric(10) }}@synthetics.dtdg.co
type: email
- id: 76636cd1-82e2-4aeb-9cfe-51366a8198a2
name: MY_GLOBAL_VAR
type: global
deviceIds:
- laptop_large
locations:
- aws:eu-central-1
message: Notify @qa
name: A Browser test on example.org
optionsList:
tickEvery: 3600
requestDefinition:
method: GET
url: https://app.datadoghq.com
status: paused
tags: []
type: browser
Create SyntheticsTest Resource
new SyntheticsTest(name: string, args: SyntheticsTestArgs, opts?: CustomResourceOptions);@overload
def SyntheticsTest(resource_name: str,
opts: Optional[ResourceOptions] = None,
api_steps: Optional[Sequence[SyntheticsTestApiStepArgs]] = None,
assertions: Optional[Sequence[SyntheticsTestAssertionArgs]] = None,
browser_steps: Optional[Sequence[SyntheticsTestBrowserStepArgs]] = None,
browser_variables: Optional[Sequence[SyntheticsTestBrowserVariableArgs]] = None,
config_variables: Optional[Sequence[SyntheticsTestConfigVariableArgs]] = None,
device_ids: Optional[Sequence[str]] = None,
locations: Optional[Sequence[str]] = None,
message: Optional[str] = None,
name: Optional[str] = None,
options_list: Optional[SyntheticsTestOptionsListArgs] = None,
request_basicauth: Optional[SyntheticsTestRequestBasicauthArgs] = None,
request_client_certificate: Optional[SyntheticsTestRequestClientCertificateArgs] = None,
request_definition: Optional[SyntheticsTestRequestDefinitionArgs] = None,
request_headers: Optional[Mapping[str, Any]] = None,
request_proxy: Optional[SyntheticsTestRequestProxyArgs] = None,
request_query: Optional[Mapping[str, Any]] = None,
set_cookie: Optional[str] = None,
status: Optional[str] = None,
subtype: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
type: Optional[str] = None)
@overload
def SyntheticsTest(resource_name: str,
args: SyntheticsTestArgs,
opts: Optional[ResourceOptions] = None)func NewSyntheticsTest(ctx *Context, name string, args SyntheticsTestArgs, opts ...ResourceOption) (*SyntheticsTest, error)public SyntheticsTest(string name, SyntheticsTestArgs args, CustomResourceOptions? opts = null)
public SyntheticsTest(String name, SyntheticsTestArgs args)
public SyntheticsTest(String name, SyntheticsTestArgs args, CustomResourceOptions options)
type: datadog:SyntheticsTest
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SyntheticsTestArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args SyntheticsTestArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args SyntheticsTestArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SyntheticsTestArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SyntheticsTestArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
SyntheticsTest Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The SyntheticsTest resource accepts the following input properties:
- Locations List<string>
Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations.
- Name string
Name of Datadog synthetics test.
- Status string
Define whether you want to start (
live) or pause (paused) a Synthetic test. Valid values arelive,paused.- Type string
Synthetics test type. Valid values are
api,browser.- Api
Steps List<SyntheticsTest Api Step Args> Steps for multistep api tests
- Assertions
List<Synthetics
Test Assertion Args> Assertions used for the test. Multiple
assertionblocks are allowed with the structure below.- Browser
Steps List<SyntheticsTest Browser Step Args> Steps for browser tests.
- Browser
Variables List<SyntheticsTest Browser Variable Args> Variables used for a browser test steps. Multiple
variableblocks are allowed with the structure below.- Config
Variables List<SyntheticsTest Config Variable Args> Variables used for the test configuration. Multiple
config_variableblocks are allowed with the structure below.- Device
Ids List<string> Required if
type = "browser". Array with the different device IDs used to run the test. Valid values arelaptop_large,tablet,mobile_small,chrome.laptop_large,chrome.tablet,chrome.mobile_small,firefox.laptop_large,firefox.tablet,firefox.mobile_small,edge.laptop_large,edge.tablet,edge.mobile_small.- Message string
A message to include with notifications for this synthetics test. Email notifications can be sent to specific users by using the same
@usernamenotation as events.- Options
List SyntheticsTest Options List Args - Request
Basicauth SyntheticsTest Request Basicauth Args The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- Request
Client SyntheticsCertificate Test Request Client Certificate Args Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- Request
Definition SyntheticsTest Request Definition Args Required if
type = "api". The synthetics test request.- Request
Headers Dictionary<string, object> Header name and value map.
- Request
Proxy SyntheticsTest Request Proxy Args The proxy to perform the test.
- Request
Query Dictionary<string, object> Query arguments name and value map.
- string
Cookies to be used for a browser test request, using the Set-Cookie syntax.
- Subtype string
The subtype of the Synthetic API test. Defaults to
http. Valid values arehttp,ssl,tcp,dns,multi,icmp,udp,websocket,grpc.- List<string>
A list of tags to associate with your synthetics test. This can help you categorize and filter tests in the manage synthetics page of the UI. Default is an empty list (
[]).
- Locations []string
Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations.
- Name string
Name of Datadog synthetics test.
- Status string
Define whether you want to start (
live) or pause (paused) a Synthetic test. Valid values arelive,paused.- Type string
Synthetics test type. Valid values are
api,browser.- Api
Steps []SyntheticsTest Api Step Args Steps for multistep api tests
- Assertions
[]Synthetics
Test Assertion Args Assertions used for the test. Multiple
assertionblocks are allowed with the structure below.- Browser
Steps []SyntheticsTest Browser Step Args Steps for browser tests.
- Browser
Variables []SyntheticsTest Browser Variable Args Variables used for a browser test steps. Multiple
variableblocks are allowed with the structure below.- Config
Variables []SyntheticsTest Config Variable Args Variables used for the test configuration. Multiple
config_variableblocks are allowed with the structure below.- Device
Ids []string Required if
type = "browser". Array with the different device IDs used to run the test. Valid values arelaptop_large,tablet,mobile_small,chrome.laptop_large,chrome.tablet,chrome.mobile_small,firefox.laptop_large,firefox.tablet,firefox.mobile_small,edge.laptop_large,edge.tablet,edge.mobile_small.- Message string
A message to include with notifications for this synthetics test. Email notifications can be sent to specific users by using the same
@usernamenotation as events.- Options
List SyntheticsTest Options List Args - Request
Basicauth SyntheticsTest Request Basicauth Args The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- Request
Client SyntheticsCertificate Test Request Client Certificate Args Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- Request
Definition SyntheticsTest Request Definition Args Required if
type = "api". The synthetics test request.- Request
Headers map[string]interface{} Header name and value map.
- Request
Proxy SyntheticsTest Request Proxy Args The proxy to perform the test.
- Request
Query map[string]interface{} Query arguments name and value map.
- string
Cookies to be used for a browser test request, using the Set-Cookie syntax.
- Subtype string
The subtype of the Synthetic API test. Defaults to
http. Valid values arehttp,ssl,tcp,dns,multi,icmp,udp,websocket,grpc.- []string
A list of tags to associate with your synthetics test. This can help you categorize and filter tests in the manage synthetics page of the UI. Default is an empty list (
[]).
- locations List<String>
Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations.
- name String
Name of Datadog synthetics test.
- status String
Define whether you want to start (
live) or pause (paused) a Synthetic test. Valid values arelive,paused.- type String
Synthetics test type. Valid values are
api,browser.- api
Steps List<SyntheticsTest Api Step Args> Steps for multistep api tests
- assertions
List<Synthetics
Test Assertion Args> Assertions used for the test. Multiple
assertionblocks are allowed with the structure below.- browser
Steps List<SyntheticsTest Browser Step Args> Steps for browser tests.
- browser
Variables List<SyntheticsTest Browser Variable Args> Variables used for a browser test steps. Multiple
variableblocks are allowed with the structure below.- config
Variables List<SyntheticsTest Config Variable Args> Variables used for the test configuration. Multiple
config_variableblocks are allowed with the structure below.- device
Ids List<String> Required if
type = "browser". Array with the different device IDs used to run the test. Valid values arelaptop_large,tablet,mobile_small,chrome.laptop_large,chrome.tablet,chrome.mobile_small,firefox.laptop_large,firefox.tablet,firefox.mobile_small,edge.laptop_large,edge.tablet,edge.mobile_small.- message String
A message to include with notifications for this synthetics test. Email notifications can be sent to specific users by using the same
@usernamenotation as events.- options
List SyntheticsTest Options List Args - request
Basicauth SyntheticsTest Request Basicauth Args The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- request
Client SyntheticsCertificate Test Request Client Certificate Args Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- request
Definition SyntheticsTest Request Definition Args Required if
type = "api". The synthetics test request.- request
Headers Map<String,Object> Header name and value map.
- request
Proxy SyntheticsTest Request Proxy Args The proxy to perform the test.
- request
Query Map<String,Object> Query arguments name and value map.
- String
Cookies to be used for a browser test request, using the Set-Cookie syntax.
- subtype String
The subtype of the Synthetic API test. Defaults to
http. Valid values arehttp,ssl,tcp,dns,multi,icmp,udp,websocket,grpc.- List<String>
A list of tags to associate with your synthetics test. This can help you categorize and filter tests in the manage synthetics page of the UI. Default is an empty list (
[]).
- locations string[]
Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations.
- name string
Name of Datadog synthetics test.
- status string
Define whether you want to start (
live) or pause (paused) a Synthetic test. Valid values arelive,paused.- type string
Synthetics test type. Valid values are
api,browser.- api
Steps SyntheticsTest Api Step Args[] Steps for multistep api tests
- assertions
Synthetics
Test Assertion Args[] Assertions used for the test. Multiple
assertionblocks are allowed with the structure below.- browser
Steps SyntheticsTest Browser Step Args[] Steps for browser tests.
- browser
Variables SyntheticsTest Browser Variable Args[] Variables used for a browser test steps. Multiple
variableblocks are allowed with the structure below.- config
Variables SyntheticsTest Config Variable Args[] Variables used for the test configuration. Multiple
config_variableblocks are allowed with the structure below.- device
Ids string[] Required if
type = "browser". Array with the different device IDs used to run the test. Valid values arelaptop_large,tablet,mobile_small,chrome.laptop_large,chrome.tablet,chrome.mobile_small,firefox.laptop_large,firefox.tablet,firefox.mobile_small,edge.laptop_large,edge.tablet,edge.mobile_small.- message string
A message to include with notifications for this synthetics test. Email notifications can be sent to specific users by using the same
@usernamenotation as events.- options
List SyntheticsTest Options List Args - request
Basicauth SyntheticsTest Request Basicauth Args The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- request
Client SyntheticsCertificate Test Request Client Certificate Args Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- request
Definition SyntheticsTest Request Definition Args Required if
type = "api". The synthetics test request.- request
Headers {[key: string]: any} Header name and value map.
- request
Proxy SyntheticsTest Request Proxy Args The proxy to perform the test.
- request
Query {[key: string]: any} Query arguments name and value map.
- string
Cookies to be used for a browser test request, using the Set-Cookie syntax.
- subtype string
The subtype of the Synthetic API test. Defaults to
http. Valid values arehttp,ssl,tcp,dns,multi,icmp,udp,websocket,grpc.- string[]
A list of tags to associate with your synthetics test. This can help you categorize and filter tests in the manage synthetics page of the UI. Default is an empty list (
[]).
- locations Sequence[str]
Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations.
- name str
Name of Datadog synthetics test.
- status str
Define whether you want to start (
live) or pause (paused) a Synthetic test. Valid values arelive,paused.- type str
Synthetics test type. Valid values are
api,browser.- api_
steps Sequence[SyntheticsTest Api Step Args] Steps for multistep api tests
- assertions
Sequence[Synthetics
Test Assertion Args] Assertions used for the test. Multiple
assertionblocks are allowed with the structure below.- browser_
steps Sequence[SyntheticsTest Browser Step Args] Steps for browser tests.
- browser_
variables Sequence[SyntheticsTest Browser Variable Args] Variables used for a browser test steps. Multiple
variableblocks are allowed with the structure below.- config_
variables Sequence[SyntheticsTest Config Variable Args] Variables used for the test configuration. Multiple
config_variableblocks are allowed with the structure below.- device_
ids Sequence[str] Required if
type = "browser". Array with the different device IDs used to run the test. Valid values arelaptop_large,tablet,mobile_small,chrome.laptop_large,chrome.tablet,chrome.mobile_small,firefox.laptop_large,firefox.tablet,firefox.mobile_small,edge.laptop_large,edge.tablet,edge.mobile_small.- message str
A message to include with notifications for this synthetics test. Email notifications can be sent to specific users by using the same
@usernamenotation as events.- options_
list SyntheticsTest Options List Args - request_
basicauth SyntheticsTest Request Basicauth Args The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- request_
client_ Syntheticscertificate Test Request Client Certificate Args Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- request_
definition SyntheticsTest Request Definition Args Required if
type = "api". The synthetics test request.- request_
headers Mapping[str, Any] Header name and value map.
- request_
proxy SyntheticsTest Request Proxy Args The proxy to perform the test.
- request_
query Mapping[str, Any] Query arguments name and value map.
- str
Cookies to be used for a browser test request, using the Set-Cookie syntax.
- subtype str
The subtype of the Synthetic API test. Defaults to
http. Valid values arehttp,ssl,tcp,dns,multi,icmp,udp,websocket,grpc.- Sequence[str]
A list of tags to associate with your synthetics test. This can help you categorize and filter tests in the manage synthetics page of the UI. Default is an empty list (
[]).
- locations List<String>
Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations.
- name String
Name of Datadog synthetics test.
- status String
Define whether you want to start (
live) or pause (paused) a Synthetic test. Valid values arelive,paused.- type String
Synthetics test type. Valid values are
api,browser.- api
Steps List<Property Map> Steps for multistep api tests
- assertions List<Property Map>
Assertions used for the test. Multiple
assertionblocks are allowed with the structure below.- browser
Steps List<Property Map> Steps for browser tests.
- browser
Variables List<Property Map> Variables used for a browser test steps. Multiple
variableblocks are allowed with the structure below.- config
Variables List<Property Map> Variables used for the test configuration. Multiple
config_variableblocks are allowed with the structure below.- device
Ids List<String> Required if
type = "browser". Array with the different device IDs used to run the test. Valid values arelaptop_large,tablet,mobile_small,chrome.laptop_large,chrome.tablet,chrome.mobile_small,firefox.laptop_large,firefox.tablet,firefox.mobile_small,edge.laptop_large,edge.tablet,edge.mobile_small.- message String
A message to include with notifications for this synthetics test. Email notifications can be sent to specific users by using the same
@usernamenotation as events.- options
List Property Map - request
Basicauth Property Map The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- request
Client Property MapCertificate Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- request
Definition Property Map Required if
type = "api". The synthetics test request.- request
Headers Map<Any> Header name and value map.
- request
Proxy Property Map The proxy to perform the test.
- request
Query Map<Any> Query arguments name and value map.
- String
Cookies to be used for a browser test request, using the Set-Cookie syntax.
- subtype String
The subtype of the Synthetic API test. Defaults to
http. Valid values arehttp,ssl,tcp,dns,multi,icmp,udp,websocket,grpc.- List<String>
A list of tags to associate with your synthetics test. This can help you categorize and filter tests in the manage synthetics page of the UI. Default is an empty list (
[]).
Outputs
All input properties are implicitly available as output properties. Additionally, the SyntheticsTest resource produces the following output properties:
- id str
The provider-assigned unique ID for this managed resource.
- monitor_
id int ID of the monitor associated with the Datadog synthetics test.
Look up Existing SyntheticsTest Resource
Get an existing SyntheticsTest resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: SyntheticsTestState, opts?: CustomResourceOptions): SyntheticsTest@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
api_steps: Optional[Sequence[SyntheticsTestApiStepArgs]] = None,
assertions: Optional[Sequence[SyntheticsTestAssertionArgs]] = None,
browser_steps: Optional[Sequence[SyntheticsTestBrowserStepArgs]] = None,
browser_variables: Optional[Sequence[SyntheticsTestBrowserVariableArgs]] = None,
config_variables: Optional[Sequence[SyntheticsTestConfigVariableArgs]] = None,
device_ids: Optional[Sequence[str]] = None,
locations: Optional[Sequence[str]] = None,
message: Optional[str] = None,
monitor_id: Optional[int] = None,
name: Optional[str] = None,
options_list: Optional[SyntheticsTestOptionsListArgs] = None,
request_basicauth: Optional[SyntheticsTestRequestBasicauthArgs] = None,
request_client_certificate: Optional[SyntheticsTestRequestClientCertificateArgs] = None,
request_definition: Optional[SyntheticsTestRequestDefinitionArgs] = None,
request_headers: Optional[Mapping[str, Any]] = None,
request_proxy: Optional[SyntheticsTestRequestProxyArgs] = None,
request_query: Optional[Mapping[str, Any]] = None,
set_cookie: Optional[str] = None,
status: Optional[str] = None,
subtype: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
type: Optional[str] = None) -> SyntheticsTestfunc GetSyntheticsTest(ctx *Context, name string, id IDInput, state *SyntheticsTestState, opts ...ResourceOption) (*SyntheticsTest, error)public static SyntheticsTest Get(string name, Input<string> id, SyntheticsTestState? state, CustomResourceOptions? opts = null)public static SyntheticsTest get(String name, Output<String> id, SyntheticsTestState state, CustomResourceOptions options)Resource lookup is not supported in YAML- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Api
Steps List<SyntheticsTest Api Step Args> Steps for multistep api tests
- Assertions
List<Synthetics
Test Assertion Args> Assertions used for the test. Multiple
assertionblocks are allowed with the structure below.- Browser
Steps List<SyntheticsTest Browser Step Args> Steps for browser tests.
- Browser
Variables List<SyntheticsTest Browser Variable Args> Variables used for a browser test steps. Multiple
variableblocks are allowed with the structure below.- Config
Variables List<SyntheticsTest Config Variable Args> Variables used for the test configuration. Multiple
config_variableblocks are allowed with the structure below.- Device
Ids List<string> Required if
type = "browser". Array with the different device IDs used to run the test. Valid values arelaptop_large,tablet,mobile_small,chrome.laptop_large,chrome.tablet,chrome.mobile_small,firefox.laptop_large,firefox.tablet,firefox.mobile_small,edge.laptop_large,edge.tablet,edge.mobile_small.- Locations List<string>
Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations.
- Message string
A message to include with notifications for this synthetics test. Email notifications can be sent to specific users by using the same
@usernamenotation as events.- Monitor
Id int ID of the monitor associated with the Datadog synthetics test.
- Name string
Name of Datadog synthetics test.
- Options
List SyntheticsTest Options List Args - Request
Basicauth SyntheticsTest Request Basicauth Args The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- Request
Client SyntheticsCertificate Test Request Client Certificate Args Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- Request
Definition SyntheticsTest Request Definition Args Required if
type = "api". The synthetics test request.- Request
Headers Dictionary<string, object> Header name and value map.
- Request
Proxy SyntheticsTest Request Proxy Args The proxy to perform the test.
- Request
Query Dictionary<string, object> Query arguments name and value map.
- string
Cookies to be used for a browser test request, using the Set-Cookie syntax.
- Status string
Define whether you want to start (
live) or pause (paused) a Synthetic test. Valid values arelive,paused.- Subtype string
The subtype of the Synthetic API test. Defaults to
http. Valid values arehttp,ssl,tcp,dns,multi,icmp,udp,websocket,grpc.- List<string>
A list of tags to associate with your synthetics test. This can help you categorize and filter tests in the manage synthetics page of the UI. Default is an empty list (
[]).- Type string
Synthetics test type. Valid values are
api,browser.
- Api
Steps []SyntheticsTest Api Step Args Steps for multistep api tests
- Assertions
[]Synthetics
Test Assertion Args Assertions used for the test. Multiple
assertionblocks are allowed with the structure below.- Browser
Steps []SyntheticsTest Browser Step Args Steps for browser tests.
- Browser
Variables []SyntheticsTest Browser Variable Args Variables used for a browser test steps. Multiple
variableblocks are allowed with the structure below.- Config
Variables []SyntheticsTest Config Variable Args Variables used for the test configuration. Multiple
config_variableblocks are allowed with the structure below.- Device
Ids []string Required if
type = "browser". Array with the different device IDs used to run the test. Valid values arelaptop_large,tablet,mobile_small,chrome.laptop_large,chrome.tablet,chrome.mobile_small,firefox.laptop_large,firefox.tablet,firefox.mobile_small,edge.laptop_large,edge.tablet,edge.mobile_small.- Locations []string
Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations.
- Message string
A message to include with notifications for this synthetics test. Email notifications can be sent to specific users by using the same
@usernamenotation as events.- Monitor
Id int ID of the monitor associated with the Datadog synthetics test.
- Name string
Name of Datadog synthetics test.
- Options
List SyntheticsTest Options List Args - Request
Basicauth SyntheticsTest Request Basicauth Args The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- Request
Client SyntheticsCertificate Test Request Client Certificate Args Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- Request
Definition SyntheticsTest Request Definition Args Required if
type = "api". The synthetics test request.- Request
Headers map[string]interface{} Header name and value map.
- Request
Proxy SyntheticsTest Request Proxy Args The proxy to perform the test.
- Request
Query map[string]interface{} Query arguments name and value map.
- string
Cookies to be used for a browser test request, using the Set-Cookie syntax.
- Status string
Define whether you want to start (
live) or pause (paused) a Synthetic test. Valid values arelive,paused.- Subtype string
The subtype of the Synthetic API test. Defaults to
http. Valid values arehttp,ssl,tcp,dns,multi,icmp,udp,websocket,grpc.- []string
A list of tags to associate with your synthetics test. This can help you categorize and filter tests in the manage synthetics page of the UI. Default is an empty list (
[]).- Type string
Synthetics test type. Valid values are
api,browser.
- api
Steps List<SyntheticsTest Api Step Args> Steps for multistep api tests
- assertions
List<Synthetics
Test Assertion Args> Assertions used for the test. Multiple
assertionblocks are allowed with the structure below.- browser
Steps List<SyntheticsTest Browser Step Args> Steps for browser tests.
- browser
Variables List<SyntheticsTest Browser Variable Args> Variables used for a browser test steps. Multiple
variableblocks are allowed with the structure below.- config
Variables List<SyntheticsTest Config Variable Args> Variables used for the test configuration. Multiple
config_variableblocks are allowed with the structure below.- device
Ids List<String> Required if
type = "browser". Array with the different device IDs used to run the test. Valid values arelaptop_large,tablet,mobile_small,chrome.laptop_large,chrome.tablet,chrome.mobile_small,firefox.laptop_large,firefox.tablet,firefox.mobile_small,edge.laptop_large,edge.tablet,edge.mobile_small.- locations List<String>
Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations.
- message String
A message to include with notifications for this synthetics test. Email notifications can be sent to specific users by using the same
@usernamenotation as events.- monitor
Id Integer ID of the monitor associated with the Datadog synthetics test.
- name String
Name of Datadog synthetics test.
- options
List SyntheticsTest Options List Args - request
Basicauth SyntheticsTest Request Basicauth Args The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- request
Client SyntheticsCertificate Test Request Client Certificate Args Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- request
Definition SyntheticsTest Request Definition Args Required if
type = "api". The synthetics test request.- request
Headers Map<String,Object> Header name and value map.
- request
Proxy SyntheticsTest Request Proxy Args The proxy to perform the test.
- request
Query Map<String,Object> Query arguments name and value map.
- String
Cookies to be used for a browser test request, using the Set-Cookie syntax.
- status String
Define whether you want to start (
live) or pause (paused) a Synthetic test. Valid values arelive,paused.- subtype String
The subtype of the Synthetic API test. Defaults to
http. Valid values arehttp,ssl,tcp,dns,multi,icmp,udp,websocket,grpc.- List<String>
A list of tags to associate with your synthetics test. This can help you categorize and filter tests in the manage synthetics page of the UI. Default is an empty list (
[]).- type String
Synthetics test type. Valid values are
api,browser.
- api
Steps SyntheticsTest Api Step Args[] Steps for multistep api tests
- assertions
Synthetics
Test Assertion Args[] Assertions used for the test. Multiple
assertionblocks are allowed with the structure below.- browser
Steps SyntheticsTest Browser Step Args[] Steps for browser tests.
- browser
Variables SyntheticsTest Browser Variable Args[] Variables used for a browser test steps. Multiple
variableblocks are allowed with the structure below.- config
Variables SyntheticsTest Config Variable Args[] Variables used for the test configuration. Multiple
config_variableblocks are allowed with the structure below.- device
Ids string[] Required if
type = "browser". Array with the different device IDs used to run the test. Valid values arelaptop_large,tablet,mobile_small,chrome.laptop_large,chrome.tablet,chrome.mobile_small,firefox.laptop_large,firefox.tablet,firefox.mobile_small,edge.laptop_large,edge.tablet,edge.mobile_small.- locations string[]
Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations.
- message string
A message to include with notifications for this synthetics test. Email notifications can be sent to specific users by using the same
@usernamenotation as events.- monitor
Id number ID of the monitor associated with the Datadog synthetics test.
- name string
Name of Datadog synthetics test.
- options
List SyntheticsTest Options List Args - request
Basicauth SyntheticsTest Request Basicauth Args The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- request
Client SyntheticsCertificate Test Request Client Certificate Args Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- request
Definition SyntheticsTest Request Definition Args Required if
type = "api". The synthetics test request.- request
Headers {[key: string]: any} Header name and value map.
- request
Proxy SyntheticsTest Request Proxy Args The proxy to perform the test.
- request
Query {[key: string]: any} Query arguments name and value map.
- string
Cookies to be used for a browser test request, using the Set-Cookie syntax.
- status string
Define whether you want to start (
live) or pause (paused) a Synthetic test. Valid values arelive,paused.- subtype string
The subtype of the Synthetic API test. Defaults to
http. Valid values arehttp,ssl,tcp,dns,multi,icmp,udp,websocket,grpc.- string[]
A list of tags to associate with your synthetics test. This can help you categorize and filter tests in the manage synthetics page of the UI. Default is an empty list (
[]).- type string
Synthetics test type. Valid values are
api,browser.
- api_
steps Sequence[SyntheticsTest Api Step Args] Steps for multistep api tests
- assertions
Sequence[Synthetics
Test Assertion Args] Assertions used for the test. Multiple
assertionblocks are allowed with the structure below.- browser_
steps Sequence[SyntheticsTest Browser Step Args] Steps for browser tests.
- browser_
variables Sequence[SyntheticsTest Browser Variable Args] Variables used for a browser test steps. Multiple
variableblocks are allowed with the structure below.- config_
variables Sequence[SyntheticsTest Config Variable Args] Variables used for the test configuration. Multiple
config_variableblocks are allowed with the structure below.- device_
ids Sequence[str] Required if
type = "browser". Array with the different device IDs used to run the test. Valid values arelaptop_large,tablet,mobile_small,chrome.laptop_large,chrome.tablet,chrome.mobile_small,firefox.laptop_large,firefox.tablet,firefox.mobile_small,edge.laptop_large,edge.tablet,edge.mobile_small.- locations Sequence[str]
Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations.
- message str
A message to include with notifications for this synthetics test. Email notifications can be sent to specific users by using the same
@usernamenotation as events.- monitor_
id int ID of the monitor associated with the Datadog synthetics test.
- name str
Name of Datadog synthetics test.
- options_
list SyntheticsTest Options List Args - request_
basicauth SyntheticsTest Request Basicauth Args The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- request_
client_ Syntheticscertificate Test Request Client Certificate Args Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- request_
definition SyntheticsTest Request Definition Args Required if
type = "api". The synthetics test request.- request_
headers Mapping[str, Any] Header name and value map.
- request_
proxy SyntheticsTest Request Proxy Args The proxy to perform the test.
- request_
query Mapping[str, Any] Query arguments name and value map.
- str
Cookies to be used for a browser test request, using the Set-Cookie syntax.
- status str
Define whether you want to start (
live) or pause (paused) a Synthetic test. Valid values arelive,paused.- subtype str
The subtype of the Synthetic API test. Defaults to
http. Valid values arehttp,ssl,tcp,dns,multi,icmp,udp,websocket,grpc.- Sequence[str]
A list of tags to associate with your synthetics test. This can help you categorize and filter tests in the manage synthetics page of the UI. Default is an empty list (
[]).- type str
Synthetics test type. Valid values are
api,browser.
- api
Steps List<Property Map> Steps for multistep api tests
- assertions List<Property Map>
Assertions used for the test. Multiple
assertionblocks are allowed with the structure below.- browser
Steps List<Property Map> Steps for browser tests.
- browser
Variables List<Property Map> Variables used for a browser test steps. Multiple
variableblocks are allowed with the structure below.- config
Variables List<Property Map> Variables used for the test configuration. Multiple
config_variableblocks are allowed with the structure below.- device
Ids List<String> Required if
type = "browser". Array with the different device IDs used to run the test. Valid values arelaptop_large,tablet,mobile_small,chrome.laptop_large,chrome.tablet,chrome.mobile_small,firefox.laptop_large,firefox.tablet,firefox.mobile_small,edge.laptop_large,edge.tablet,edge.mobile_small.- locations List<String>
Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations.
- message String
A message to include with notifications for this synthetics test. Email notifications can be sent to specific users by using the same
@usernamenotation as events.- monitor
Id Number ID of the monitor associated with the Datadog synthetics test.
- name String
Name of Datadog synthetics test.
- options
List Property Map - request
Basicauth Property Map The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- request
Client Property MapCertificate Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- request
Definition Property Map Required if
type = "api". The synthetics test request.- request
Headers Map<Any> Header name and value map.
- request
Proxy Property Map The proxy to perform the test.
- request
Query Map<Any> Query arguments name and value map.
- String
Cookies to be used for a browser test request, using the Set-Cookie syntax.
- status String
Define whether you want to start (
live) or pause (paused) a Synthetic test. Valid values arelive,paused.- subtype String
The subtype of the Synthetic API test. Defaults to
http. Valid values arehttp,ssl,tcp,dns,multi,icmp,udp,websocket,grpc.- List<String>
A list of tags to associate with your synthetics test. This can help you categorize and filter tests in the manage synthetics page of the UI. Default is an empty list (
[]).- type String
Synthetics test type. Valid values are
api,browser.
Supporting Types
SyntheticsTestApiStep
- Name string
The name of the step.
- Allow
Failure bool Determines whether or not to continue with test if this step fails.
- Assertions
List<Synthetics
Test Api Step Assertion> Assertions used for the test. Multiple
assertionblocks are allowed with the structure below.- Extracted
Values List<SyntheticsTest Api Step Extracted Value> Values to parse and save as variables from the response.
- Is
Critical bool Determines whether or not to consider the entire test as failed if this step fails. Can be used only if
allow_failureistrue.- Request
Basicauth SyntheticsTest Api Step Request Basicauth The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- Request
Client SyntheticsCertificate Test Api Step Request Client Certificate Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- Request
Definition SyntheticsTest Api Step Request Definition The request for the api step.
- Request
Headers Dictionary<string, object> Header name and value map.
- Request
Proxy SyntheticsTest Api Step Request Proxy The proxy to perform the test.
- Request
Query Dictionary<string, object> Query arguments name and value map.
- Retry
Synthetics
Test Api Step Retry - Subtype string
The subtype of the Synthetic multistep API test step. Valid values are
http.
- Name string
The name of the step.
- Allow
Failure bool Determines whether or not to continue with test if this step fails.
- Assertions
[]Synthetics
Test Api Step Assertion Assertions used for the test. Multiple
assertionblocks are allowed with the structure below.- Extracted
Values []SyntheticsTest Api Step Extracted Value Values to parse and save as variables from the response.
- Is
Critical bool Determines whether or not to consider the entire test as failed if this step fails. Can be used only if
allow_failureistrue.- Request
Basicauth SyntheticsTest Api Step Request Basicauth The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- Request
Client SyntheticsCertificate Test Api Step Request Client Certificate Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- Request
Definition SyntheticsTest Api Step Request Definition The request for the api step.
- Request
Headers map[string]interface{} Header name and value map.
- Request
Proxy SyntheticsTest Api Step Request Proxy The proxy to perform the test.
- Request
Query map[string]interface{} Query arguments name and value map.
- Retry
Synthetics
Test Api Step Retry - Subtype string
The subtype of the Synthetic multistep API test step. Valid values are
http.
- name String
The name of the step.
- allow
Failure Boolean Determines whether or not to continue with test if this step fails.
- assertions
List<Synthetics
Test Api Step Assertion> Assertions used for the test. Multiple
assertionblocks are allowed with the structure below.- extracted
Values List<SyntheticsTest Api Step Extracted Value> Values to parse and save as variables from the response.
- is
Critical Boolean Determines whether or not to consider the entire test as failed if this step fails. Can be used only if
allow_failureistrue.- request
Basicauth SyntheticsTest Api Step Request Basicauth The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- request
Client SyntheticsCertificate Test Api Step Request Client Certificate Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- request
Definition SyntheticsTest Api Step Request Definition The request for the api step.
- request
Headers Map<String,Object> Header name and value map.
- request
Proxy SyntheticsTest Api Step Request Proxy The proxy to perform the test.
- request
Query Map<String,Object> Query arguments name and value map.
- retry
Synthetics
Test Api Step Retry - subtype String
The subtype of the Synthetic multistep API test step. Valid values are
http.
- name string
The name of the step.
- allow
Failure boolean Determines whether or not to continue with test if this step fails.
- assertions
Synthetics
Test Api Step Assertion[] Assertions used for the test. Multiple
assertionblocks are allowed with the structure below.- extracted
Values SyntheticsTest Api Step Extracted Value[] Values to parse and save as variables from the response.
- is
Critical boolean Determines whether or not to consider the entire test as failed if this step fails. Can be used only if
allow_failureistrue.- request
Basicauth SyntheticsTest Api Step Request Basicauth The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- request
Client SyntheticsCertificate Test Api Step Request Client Certificate Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- request
Definition SyntheticsTest Api Step Request Definition The request for the api step.
- request
Headers {[key: string]: any} Header name and value map.
- request
Proxy SyntheticsTest Api Step Request Proxy The proxy to perform the test.
- request
Query {[key: string]: any} Query arguments name and value map.
- retry
Synthetics
Test Api Step Retry - subtype string
The subtype of the Synthetic multistep API test step. Valid values are
http.
- name str
The name of the step.
- allow_
failure bool Determines whether or not to continue with test if this step fails.
- assertions
Sequence[Synthetics
Test Api Step Assertion] Assertions used for the test. Multiple
assertionblocks are allowed with the structure below.- extracted_
values Sequence[SyntheticsTest Api Step Extracted Value] Values to parse and save as variables from the response.
- is_
critical bool Determines whether or not to consider the entire test as failed if this step fails. Can be used only if
allow_failureistrue.- request_
basicauth SyntheticsTest Api Step Request Basicauth The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- request_
client_ Syntheticscertificate Test Api Step Request Client Certificate Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- request_
definition SyntheticsTest Api Step Request Definition The request for the api step.
- request_
headers Mapping[str, Any] Header name and value map.
- request_
proxy SyntheticsTest Api Step Request Proxy The proxy to perform the test.
- request_
query Mapping[str, Any] Query arguments name and value map.
- retry
Synthetics
Test Api Step Retry - subtype str
The subtype of the Synthetic multistep API test step. Valid values are
http.
- name String
The name of the step.
- allow
Failure Boolean Determines whether or not to continue with test if this step fails.
- assertions List<Property Map>
Assertions used for the test. Multiple
assertionblocks are allowed with the structure below.- extracted
Values List<Property Map> Values to parse and save as variables from the response.
- is
Critical Boolean Determines whether or not to consider the entire test as failed if this step fails. Can be used only if
allow_failureistrue.- request
Basicauth Property Map The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- request
Client Property MapCertificate Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- request
Definition Property Map The request for the api step.
- request
Headers Map<Any> Header name and value map.
- request
Proxy Property Map The proxy to perform the test.
- request
Query Map<Any> Query arguments name and value map.
- retry Property Map
- subtype String
The subtype of the Synthetic multistep API test step. Valid values are
http.
SyntheticsTestApiStepAssertion
- Operator string
Assertion operator. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation).- Type string
Type of assertion. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). Valid values arebody,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection.- Property string
If assertion type is
header, this is the header name.- Target string
Expected value. Depends on the assertion type, refer to Datadog documentation for details.
- Targetjsonpath
Synthetics
Test Api Step Assertion Targetjsonpath Expected structure if
operatorisvalidatesJSONPath. Exactly one nested block is allowed with the structure below.- Targetxpath
Synthetics
Test Api Step Assertion Targetxpath Expected structure if
operatorisvalidatesXPath. Exactly one nested block is allowed with the structure below.
- Operator string
Assertion operator. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation).- Type string
Type of assertion. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). Valid values arebody,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection.- Property string
If assertion type is
header, this is the header name.- Target string
Expected value. Depends on the assertion type, refer to Datadog documentation for details.
- Targetjsonpath
Synthetics
Test Api Step Assertion Targetjsonpath Expected structure if
operatorisvalidatesJSONPath. Exactly one nested block is allowed with the structure below.- Targetxpath
Synthetics
Test Api Step Assertion Targetxpath Expected structure if
operatorisvalidatesXPath. Exactly one nested block is allowed with the structure below.
- operator String
Assertion operator. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation).- type String
Type of assertion. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). Valid values arebody,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection.- property String
If assertion type is
header, this is the header name.- target String
Expected value. Depends on the assertion type, refer to Datadog documentation for details.
- targetjsonpath
Synthetics
Test Api Step Assertion Targetjsonpath Expected structure if
operatorisvalidatesJSONPath. Exactly one nested block is allowed with the structure below.- targetxpath
Synthetics
Test Api Step Assertion Targetxpath Expected structure if
operatorisvalidatesXPath. Exactly one nested block is allowed with the structure below.
- operator string
Assertion operator. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation).- type string
Type of assertion. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). Valid values arebody,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection.- property string
If assertion type is
header, this is the header name.- target string
Expected value. Depends on the assertion type, refer to Datadog documentation for details.
- targetjsonpath
Synthetics
Test Api Step Assertion Targetjsonpath Expected structure if
operatorisvalidatesJSONPath. Exactly one nested block is allowed with the structure below.- targetxpath
Synthetics
Test Api Step Assertion Targetxpath Expected structure if
operatorisvalidatesXPath. Exactly one nested block is allowed with the structure below.
- operator str
Assertion operator. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation).- type str
Type of assertion. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). Valid values arebody,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection.- property str
If assertion type is
header, this is the header name.- target str
Expected value. Depends on the assertion type, refer to Datadog documentation for details.
- targetjsonpath
Synthetics
Test Api Step Assertion Targetjsonpath Expected structure if
operatorisvalidatesJSONPath. Exactly one nested block is allowed with the structure below.- targetxpath
Synthetics
Test Api Step Assertion Targetxpath Expected structure if
operatorisvalidatesXPath. Exactly one nested block is allowed with the structure below.
- operator String
Assertion operator. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation).- type String
Type of assertion. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). Valid values arebody,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection.- property String
If assertion type is
header, this is the header name.- target String
Expected value. Depends on the assertion type, refer to Datadog documentation for details.
- targetjsonpath Property Map
Expected structure if
operatorisvalidatesJSONPath. Exactly one nested block is allowed with the structure below.- targetxpath Property Map
Expected structure if
operatorisvalidatesXPath. Exactly one nested block is allowed with the structure below.
SyntheticsTestApiStepAssertionTargetjsonpath
- Jsonpath string
- Operator string
- Targetvalue string
- Jsonpath string
- Operator string
- Targetvalue string
- jsonpath String
- operator String
- targetvalue String
- jsonpath string
- operator string
- targetvalue string
- jsonpath str
- operator str
- targetvalue str
- jsonpath String
- operator String
- targetvalue String
SyntheticsTestApiStepAssertionTargetxpath
- Operator string
- Xpath string
- Targetvalue string
- Operator string
- Xpath string
- Targetvalue string
- operator String
- xpath String
- targetvalue String
- operator string
- xpath string
- targetvalue string
- operator str
- xpath str
- targetvalue str
- operator String
- xpath String
- targetvalue String
SyntheticsTestApiStepExtractedValue
- Name string
Name of Datadog synthetics test.
- Parser
Synthetics
Test Api Step Extracted Value Parser - Type string
Synthetics test type. Valid values are
api,browser.- Field string
- Name string
Name of Datadog synthetics test.
- Parser
Synthetics
Test Api Step Extracted Value Parser - Type string
Synthetics test type. Valid values are
api,browser.- Field string
- name String
Name of Datadog synthetics test.
- parser
Synthetics
Test Api Step Extracted Value Parser - type String
Synthetics test type. Valid values are
api,browser.- field String
- name string
Name of Datadog synthetics test.
- parser
Synthetics
Test Api Step Extracted Value Parser - type string
Synthetics test type. Valid values are
api,browser.- field string
- name str
Name of Datadog synthetics test.
- parser
Synthetics
Test Api Step Extracted Value Parser - type str
Synthetics test type. Valid values are
api,browser.- field str
- name String
Name of Datadog synthetics test.
- parser Property Map
- type String
Synthetics test type. Valid values are
api,browser.- field String
SyntheticsTestApiStepExtractedValueParser
SyntheticsTestApiStepRequestBasicauth
- Access
Key string Access key for
SIGV4authentication.- Access
Token stringUrl Access token url for
oauth-clientoroauth-ropauthentication.- Audience string
Audience for
oauth-clientoroauth-ropauthentication.- Client
Id string Client ID for
oauth-clientoroauth-ropauthentication.- Client
Secret string Client secret for
oauth-clientoroauth-ropauthentication.- Domain string
Domain for
ntlmauthentication.- Password string
Password for authentication.
- Region string
Region for
SIGV4authentication.- Resource string
Resource for
oauth-clientoroauth-ropauthentication.- Scope string
Scope for
oauth-clientoroauth-ropauthentication.- Secret
Key string Secret key for
SIGV4authentication.- Service
Name string Service name for
SIGV4authentication.- Session
Token string Session token for
SIGV4authentication.- Token
Api stringAuthentication Token API Authentication for
oauth-clientoroauth-ropauthentication. Valid values areheader,body.- Type string
Type of basic authentication to use when performing the test.
- Username string
Username for authentication.
- Workstation string
Workstation for
ntlmauthentication.
- Access
Key string Access key for
SIGV4authentication.- Access
Token stringUrl Access token url for
oauth-clientoroauth-ropauthentication.- Audience string
Audience for
oauth-clientoroauth-ropauthentication.- Client
Id string Client ID for
oauth-clientoroauth-ropauthentication.- Client
Secret string Client secret for
oauth-clientoroauth-ropauthentication.- Domain string
Domain for
ntlmauthentication.- Password string
Password for authentication.
- Region string
Region for
SIGV4authentication.- Resource string
Resource for
oauth-clientoroauth-ropauthentication.- Scope string
Scope for
oauth-clientoroauth-ropauthentication.- Secret
Key string Secret key for
SIGV4authentication.- Service
Name string Service name for
SIGV4authentication.- Session
Token string Session token for
SIGV4authentication.- Token
Api stringAuthentication Token API Authentication for
oauth-clientoroauth-ropauthentication. Valid values areheader,body.- Type string
Type of basic authentication to use when performing the test.
- Username string
Username for authentication.
- Workstation string
Workstation for
ntlmauthentication.
- access
Key String Access key for
SIGV4authentication.- access
Token StringUrl Access token url for
oauth-clientoroauth-ropauthentication.- audience String
Audience for
oauth-clientoroauth-ropauthentication.- client
Id String Client ID for
oauth-clientoroauth-ropauthentication.- client
Secret String Client secret for
oauth-clientoroauth-ropauthentication.- domain String
Domain for
ntlmauthentication.- password String
Password for authentication.
- region String
Region for
SIGV4authentication.- resource String
Resource for
oauth-clientoroauth-ropauthentication.- scope String
Scope for
oauth-clientoroauth-ropauthentication.- secret
Key String Secret key for
SIGV4authentication.- service
Name String Service name for
SIGV4authentication.- session
Token String Session token for
SIGV4authentication.- token
Api StringAuthentication Token API Authentication for
oauth-clientoroauth-ropauthentication. Valid values areheader,body.- type String
Type of basic authentication to use when performing the test.
- username String
Username for authentication.
- workstation String
Workstation for
ntlmauthentication.
- access
Key string Access key for
SIGV4authentication.- access
Token stringUrl Access token url for
oauth-clientoroauth-ropauthentication.- audience string
Audience for
oauth-clientoroauth-ropauthentication.- client
Id string Client ID for
oauth-clientoroauth-ropauthentication.- client
Secret string Client secret for
oauth-clientoroauth-ropauthentication.- domain string
Domain for
ntlmauthentication.- password string
Password for authentication.
- region string
Region for
SIGV4authentication.- resource string
Resource for
oauth-clientoroauth-ropauthentication.- scope string
Scope for
oauth-clientoroauth-ropauthentication.- secret
Key string Secret key for
SIGV4authentication.- service
Name string Service name for
SIGV4authentication.- session
Token string Session token for
SIGV4authentication.- token
Api stringAuthentication Token API Authentication for
oauth-clientoroauth-ropauthentication. Valid values areheader,body.- type string
Type of basic authentication to use when performing the test.
- username string
Username for authentication.
- workstation string
Workstation for
ntlmauthentication.
- access_
key str Access key for
SIGV4authentication.- access_
token_ strurl Access token url for
oauth-clientoroauth-ropauthentication.- audience str
Audience for
oauth-clientoroauth-ropauthentication.- client_
id str Client ID for
oauth-clientoroauth-ropauthentication.- client_
secret str Client secret for
oauth-clientoroauth-ropauthentication.- domain str
Domain for
ntlmauthentication.- password str
Password for authentication.
- region str
Region for
SIGV4authentication.- resource str
Resource for
oauth-clientoroauth-ropauthentication.- scope str
Scope for
oauth-clientoroauth-ropauthentication.- secret_
key str Secret key for
SIGV4authentication.- service_
name str Service name for
SIGV4authentication.- session_
token str Session token for
SIGV4authentication.- token_
api_ strauthentication Token API Authentication for
oauth-clientoroauth-ropauthentication. Valid values areheader,body.- type str
Type of basic authentication to use when performing the test.
- username str
Username for authentication.
- workstation str
Workstation for
ntlmauthentication.
- access
Key String Access key for
SIGV4authentication.- access
Token StringUrl Access token url for
oauth-clientoroauth-ropauthentication.- audience String
Audience for
oauth-clientoroauth-ropauthentication.- client
Id String Client ID for
oauth-clientoroauth-ropauthentication.- client
Secret String Client secret for
oauth-clientoroauth-ropauthentication.- domain String
Domain for
ntlmauthentication.- password String
Password for authentication.
- region String
Region for
SIGV4authentication.- resource String
Resource for
oauth-clientoroauth-ropauthentication.- scope String
Scope for
oauth-clientoroauth-ropauthentication.- secret
Key String Secret key for
SIGV4authentication.- service
Name String Service name for
SIGV4authentication.- session
Token String Session token for
SIGV4authentication.- token
Api StringAuthentication Token API Authentication for
oauth-clientoroauth-ropauthentication. Valid values areheader,body.- type String
Type of basic authentication to use when performing the test.
- username String
Username for authentication.
- workstation String
Workstation for
ntlmauthentication.
SyntheticsTestApiStepRequestClientCertificate
SyntheticsTestApiStepRequestClientCertificateCert
SyntheticsTestApiStepRequestClientCertificateKey
SyntheticsTestApiStepRequestDefinition
- Allow
Insecure bool - Body string
The request body.
- Body
Type string Type of the request body. Valid values are
text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql.- Call
Type string The type of gRPC call to perform. Valid values are
healthcheck,unary.- Certificate
Domains List<string> By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in
certificate_domains.- Dns
Server string DNS server to use for DNS tests (
subtype = "dns").- Dns
Server intPort DNS server port to use for DNS tests.
- Follow
Redirects bool - Host string
Host name to perform the test with.
- Message string
For UDP and websocket tests, message to send with the request.
- Method string
Either the HTTP method/verb to use or a gRPC method available on the service set in the
servicefield. Required ifsubtypeisHTTPor ifsubtypeisgrpcandcallTypeisunary.- No
Saving boolResponse Body Determines whether or not to save the response body.
- Number
Of intPackets Number of pings to use per test for ICMP tests (
subtype = "icmp") between 0 and 10.- Port int
Port to use when performing the test.
- Servername string
For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.
- Service string
The gRPC service on which you want to perform the gRPC call.
- Should
Track boolHops This will turn on a traceroute probe to discover all gateways along the path to the host destination. For ICMP tests (
subtype = "icmp").- Timeout int
Timeout in seconds for the test. Defaults to
60.- Url string
The URL to send the request to.
- Allow
Insecure bool - Body string
The request body.
- Body
Type string Type of the request body. Valid values are
text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql.- Call
Type string The type of gRPC call to perform. Valid values are
healthcheck,unary.- Certificate
Domains []string By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in
certificate_domains.- Dns
Server string DNS server to use for DNS tests (
subtype = "dns").- Dns
Server intPort DNS server port to use for DNS tests.
- Follow
Redirects bool - Host string
Host name to perform the test with.
- Message string
For UDP and websocket tests, message to send with the request.
- Method string
Either the HTTP method/verb to use or a gRPC method available on the service set in the
servicefield. Required ifsubtypeisHTTPor ifsubtypeisgrpcandcallTypeisunary.- No
Saving boolResponse Body Determines whether or not to save the response body.
- Number
Of intPackets Number of pings to use per test for ICMP tests (
subtype = "icmp") between 0 and 10.- Port int
Port to use when performing the test.
- Servername string
For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.
- Service string
The gRPC service on which you want to perform the gRPC call.
- Should
Track boolHops This will turn on a traceroute probe to discover all gateways along the path to the host destination. For ICMP tests (
subtype = "icmp").- Timeout int
Timeout in seconds for the test. Defaults to
60.- Url string
The URL to send the request to.
- allow
Insecure Boolean - body String
The request body.
- body
Type String Type of the request body. Valid values are
text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql.- call
Type String The type of gRPC call to perform. Valid values are
healthcheck,unary.- certificate
Domains List<String> By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in
certificate_domains.- dns
Server String DNS server to use for DNS tests (
subtype = "dns").- dns
Server IntegerPort DNS server port to use for DNS tests.
- follow
Redirects Boolean - host String
Host name to perform the test with.
- message String
For UDP and websocket tests, message to send with the request.
- method String
Either the HTTP method/verb to use or a gRPC method available on the service set in the
servicefield. Required ifsubtypeisHTTPor ifsubtypeisgrpcandcallTypeisunary.- no
Saving BooleanResponse Body Determines whether or not to save the response body.
- number
Of IntegerPackets Number of pings to use per test for ICMP tests (
subtype = "icmp") between 0 and 10.- port Integer
Port to use when performing the test.
- servername String
For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.
- service String
The gRPC service on which you want to perform the gRPC call.
- should
Track BooleanHops This will turn on a traceroute probe to discover all gateways along the path to the host destination. For ICMP tests (
subtype = "icmp").- timeout Integer
Timeout in seconds for the test. Defaults to
60.- url String
The URL to send the request to.
- allow
Insecure boolean - body string
The request body.
- body
Type string Type of the request body. Valid values are
text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql.- call
Type string The type of gRPC call to perform. Valid values are
healthcheck,unary.- certificate
Domains string[] By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in
certificate_domains.- dns
Server string DNS server to use for DNS tests (
subtype = "dns").- dns
Server numberPort DNS server port to use for DNS tests.
- follow
Redirects boolean - host string
Host name to perform the test with.
- message string
For UDP and websocket tests, message to send with the request.
- method string
Either the HTTP method/verb to use or a gRPC method available on the service set in the
servicefield. Required ifsubtypeisHTTPor ifsubtypeisgrpcandcallTypeisunary.- no
Saving booleanResponse Body Determines whether or not to save the response body.
- number
Of numberPackets Number of pings to use per test for ICMP tests (
subtype = "icmp") between 0 and 10.- port number
Port to use when performing the test.
- servername string
For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.
- service string
The gRPC service on which you want to perform the gRPC call.
- should
Track booleanHops This will turn on a traceroute probe to discover all gateways along the path to the host destination. For ICMP tests (
subtype = "icmp").- timeout number
Timeout in seconds for the test. Defaults to
60.- url string
The URL to send the request to.
- allow_
insecure bool - body str
The request body.
- body_
type str Type of the request body. Valid values are
text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql.- call_
type str The type of gRPC call to perform. Valid values are
healthcheck,unary.- certificate_
domains Sequence[str] By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in
certificate_domains.- dns_
server str DNS server to use for DNS tests (
subtype = "dns").- dns_
server_ intport DNS server port to use for DNS tests.
- follow_
redirects bool - host str
Host name to perform the test with.
- message str
For UDP and websocket tests, message to send with the request.
- method str
Either the HTTP method/verb to use or a gRPC method available on the service set in the
servicefield. Required ifsubtypeisHTTPor ifsubtypeisgrpcandcallTypeisunary.- no_
saving_ boolresponse_ body Determines whether or not to save the response body.
- number_
of_ intpackets Number of pings to use per test for ICMP tests (
subtype = "icmp") between 0 and 10.- port int
Port to use when performing the test.
- servername str
For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.
- service str
The gRPC service on which you want to perform the gRPC call.
- should_
track_ boolhops This will turn on a traceroute probe to discover all gateways along the path to the host destination. For ICMP tests (
subtype = "icmp").- timeout int
Timeout in seconds for the test. Defaults to
60.- url str
The URL to send the request to.
- allow
Insecure Boolean - body String
The request body.
- body
Type String Type of the request body. Valid values are
text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql.- call
Type String The type of gRPC call to perform. Valid values are
healthcheck,unary.- certificate
Domains List<String> By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in
certificate_domains.- dns
Server String DNS server to use for DNS tests (
subtype = "dns").- dns
Server NumberPort DNS server port to use for DNS tests.
- follow
Redirects Boolean - host String
Host name to perform the test with.
- message String
For UDP and websocket tests, message to send with the request.
- method String
Either the HTTP method/verb to use or a gRPC method available on the service set in the
servicefield. Required ifsubtypeisHTTPor ifsubtypeisgrpcandcallTypeisunary.- no
Saving BooleanResponse Body Determines whether or not to save the response body.
- number
Of NumberPackets Number of pings to use per test for ICMP tests (
subtype = "icmp") between 0 and 10.- port Number
Port to use when performing the test.
- servername String
For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.
- service String
The gRPC service on which you want to perform the gRPC call.
- should
Track BooleanHops This will turn on a traceroute probe to discover all gateways along the path to the host destination. For ICMP tests (
subtype = "icmp").- timeout Number
Timeout in seconds for the test. Defaults to
60.- url String
The URL to send the request to.
SyntheticsTestApiStepRequestProxy
SyntheticsTestApiStepRetry
SyntheticsTestAssertion
- Operator string
Assertion operator. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation).- Type string
Type of assertion. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). Valid values arebody,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection.- Property string
If assertion type is
header, this is the header name.- Target string
Expected value. Depends on the assertion type, refer to Datadog documentation for details.
- Targetjsonpath
Synthetics
Test Assertion Targetjsonpath Expected structure if
operatorisvalidatesJSONPath. Exactly one nested block is allowed with the structure below.- Targetxpath
Synthetics
Test Assertion Targetxpath Expected structure if
operatorisvalidatesXPath. Exactly one nested block is allowed with the structure below.
- Operator string
Assertion operator. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation).- Type string
Type of assertion. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). Valid values arebody,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection.- Property string
If assertion type is
header, this is the header name.- Target string
Expected value. Depends on the assertion type, refer to Datadog documentation for details.
- Targetjsonpath
Synthetics
Test Assertion Targetjsonpath Expected structure if
operatorisvalidatesJSONPath. Exactly one nested block is allowed with the structure below.- Targetxpath
Synthetics
Test Assertion Targetxpath Expected structure if
operatorisvalidatesXPath. Exactly one nested block is allowed with the structure below.
- operator String
Assertion operator. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation).- type String
Type of assertion. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). Valid values arebody,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection.- property String
If assertion type is
header, this is the header name.- target String
Expected value. Depends on the assertion type, refer to Datadog documentation for details.
- targetjsonpath
Synthetics
Test Assertion Targetjsonpath Expected structure if
operatorisvalidatesJSONPath. Exactly one nested block is allowed with the structure below.- targetxpath
Synthetics
Test Assertion Targetxpath Expected structure if
operatorisvalidatesXPath. Exactly one nested block is allowed with the structure below.
- operator string
Assertion operator. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation).- type string
Type of assertion. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). Valid values arebody,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection.- property string
If assertion type is
header, this is the header name.- target string
Expected value. Depends on the assertion type, refer to Datadog documentation for details.
- targetjsonpath
Synthetics
Test Assertion Targetjsonpath Expected structure if
operatorisvalidatesJSONPath. Exactly one nested block is allowed with the structure below.- targetxpath
Synthetics
Test Assertion Targetxpath Expected structure if
operatorisvalidatesXPath. Exactly one nested block is allowed with the structure below.
- operator str
Assertion operator. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation).- type str
Type of assertion. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). Valid values arebody,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection.- property str
If assertion type is
header, this is the header name.- target str
Expected value. Depends on the assertion type, refer to Datadog documentation for details.
- targetjsonpath
Synthetics
Test Assertion Targetjsonpath Expected structure if
operatorisvalidatesJSONPath. Exactly one nested block is allowed with the structure below.- targetxpath
Synthetics
Test Assertion Targetxpath Expected structure if
operatorisvalidatesXPath. Exactly one nested block is allowed with the structure below.
- operator String
Assertion operator. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation).- type String
Type of assertion. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). Valid values arebody,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection.- property String
If assertion type is
header, this is the header name.- target String
Expected value. Depends on the assertion type, refer to Datadog documentation for details.
- targetjsonpath Property Map
Expected structure if
operatorisvalidatesJSONPath. Exactly one nested block is allowed with the structure below.- targetxpath Property Map
Expected structure if
operatorisvalidatesXPath. Exactly one nested block is allowed with the structure below.
SyntheticsTestAssertionTargetjsonpath
- Jsonpath string
- Operator string
- Targetvalue string
- Jsonpath string
- Operator string
- Targetvalue string
- jsonpath String
- operator String
- targetvalue String
- jsonpath string
- operator string
- targetvalue string
- jsonpath str
- operator str
- targetvalue str
- jsonpath String
- operator String
- targetvalue String
SyntheticsTestAssertionTargetxpath
- Operator string
- Xpath string
- Targetvalue string
- Operator string
- Xpath string
- Targetvalue string
- operator String
- xpath String
- targetvalue String
- operator string
- xpath string
- targetvalue string
- operator str
- xpath str
- targetvalue str
- operator String
- xpath String
- targetvalue String
SyntheticsTestBrowserStep
- Name string
Name of the step.
- Params
Synthetics
Test Browser Step Params Parameters for the step.
- Type string
Type of the step. Valid values are
assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait.- Allow
Failure bool Determines if the step should be allowed to fail.
- Force
Element boolUpdate Force update of the "element" parameter for the step
- Is
Critical bool Determines whether or not to consider the entire test as failed if this step fails. Can be used only if
allow_failureistrue.- No
Screenshot bool Prevents saving screenshots of the step.
- Timeout int
Used to override the default timeout of a step.
- Name string
Name of the step.
- Params
Synthetics
Test Browser Step Params Parameters for the step.
- Type string
Type of the step. Valid values are
assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait.- Allow
Failure bool Determines if the step should be allowed to fail.
- Force
Element boolUpdate Force update of the "element" parameter for the step
- Is
Critical bool Determines whether or not to consider the entire test as failed if this step fails. Can be used only if
allow_failureistrue.- No
Screenshot bool Prevents saving screenshots of the step.
- Timeout int
Used to override the default timeout of a step.
- name String
Name of the step.
- params
Synthetics
Test Browser Step Params Parameters for the step.
- type String
Type of the step. Valid values are
assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait.- allow
Failure Boolean Determines if the step should be allowed to fail.
- force
Element BooleanUpdate Force update of the "element" parameter for the step
- is
Critical Boolean Determines whether or not to consider the entire test as failed if this step fails. Can be used only if
allow_failureistrue.- no
Screenshot Boolean Prevents saving screenshots of the step.
- timeout Integer
Used to override the default timeout of a step.
- name string
Name of the step.
- params
Synthetics
Test Browser Step Params Parameters for the step.
- type string
Type of the step. Valid values are
assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait.- allow
Failure boolean Determines if the step should be allowed to fail.
- force
Element booleanUpdate Force update of the "element" parameter for the step
- is
Critical boolean Determines whether or not to consider the entire test as failed if this step fails. Can be used only if
allow_failureistrue.- no
Screenshot boolean Prevents saving screenshots of the step.
- timeout number
Used to override the default timeout of a step.
- name str
Name of the step.
- params
Synthetics
Test Browser Step Params Parameters for the step.
- type str
Type of the step. Valid values are
assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait.- allow_
failure bool Determines if the step should be allowed to fail.
- force_
element_ boolupdate Force update of the "element" parameter for the step
- is_
critical bool Determines whether or not to consider the entire test as failed if this step fails. Can be used only if
allow_failureistrue.- no_
screenshot bool Prevents saving screenshots of the step.
- timeout int
Used to override the default timeout of a step.
- name String
Name of the step.
- params Property Map
Parameters for the step.
- type String
Type of the step. Valid values are
assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait.- allow
Failure Boolean Determines if the step should be allowed to fail.
- force
Element BooleanUpdate Force update of the "element" parameter for the step
- is
Critical Boolean Determines whether or not to consider the entire test as failed if this step fails. Can be used only if
allow_failureistrue.- no
Screenshot Boolean Prevents saving screenshots of the step.
- timeout Number
Used to override the default timeout of a step.
SyntheticsTestBrowserStepParams
- Attribute string
- Check string
- Click
Type string - Code string
- Delay int
- Element string
- Element
User SyntheticsLocator Test Browser Step Params Element User Locator - Email string
- File string
- Files string
- Modifiers List<string>
- Playing
Tab stringId - Request string
- Subtest
Public stringId - Value string
- Variable
Synthetics
Test Browser Step Params Variable - With
Click bool - X int
- Y int
- Attribute string
- Check string
- Click
Type string - Code string
- Delay int
- Element string
- Element
User SyntheticsLocator Test Browser Step Params Element User Locator - Email string
- File string
- Files string
- Modifiers []string
- Playing
Tab stringId - Request string
- Subtest
Public stringId - Value string
- Variable
Synthetics
Test Browser Step Params Variable - With
Click bool - X int
- Y int
- attribute String
- check String
- click
Type String - code String
- delay Integer
- element String
- element
User SyntheticsLocator Test Browser Step Params Element User Locator - email String
- file String
- files String
- modifiers List<String>
- playing
Tab StringId - request String
- subtest
Public StringId - value String
- variable
Synthetics
Test Browser Step Params Variable - with
Click Boolean - x Integer
- y Integer
- attribute string
- check string
- click
Type string - code string
- delay number
- element string
- element
User SyntheticsLocator Test Browser Step Params Element User Locator - email string
- file string
- files string
- modifiers string[]
- playing
Tab stringId - request string
- subtest
Public stringId - value string
- variable
Synthetics
Test Browser Step Params Variable - with
Click boolean - x number
- y number
- attribute str
- check str
- click_
type str - code str
- delay int
- element str
- element_
user_ Syntheticslocator Test Browser Step Params Element User Locator - email str
- file str
- files str
- modifiers Sequence[str]
- playing_
tab_ strid - request str
- subtest_
public_ strid - value str
- variable
Synthetics
Test Browser Step Params Variable - with_
click bool - x int
- y int
- attribute String
- check String
- click
Type String - code String
- delay Number
- element String
- element
User Property MapLocator - email String
- file String
- files String
- modifiers List<String>
- playing
Tab StringId - request String
- subtest
Public StringId - value String
- variable Property Map
- with
Click Boolean - x Number
- y Number
SyntheticsTestBrowserStepParamsElementUserLocator
SyntheticsTestBrowserStepParamsElementUserLocatorValue
SyntheticsTestBrowserStepParamsVariable
SyntheticsTestBrowserVariable
- Name string
Name of the variable.
- Type string
Type of browser test variable. Valid values are
element,email,global,javascript,text.- Example string
Example for the variable.
- Id string
ID of the global variable to use. This is actually only used (and required) in the case of using a variable of type
global.- Pattern string
Pattern of the variable.
- Name string
Name of the variable.
- Type string
Type of browser test variable. Valid values are
element,email,global,javascript,text.- Example string
Example for the variable.
- Id string
ID of the global variable to use. This is actually only used (and required) in the case of using a variable of type
global.- Pattern string
Pattern of the variable.
- name String
Name of the variable.
- type String
Type of browser test variable. Valid values are
element,email,global,javascript,text.- example String
Example for the variable.
- id String
ID of the global variable to use. This is actually only used (and required) in the case of using a variable of type
global.- pattern String
Pattern of the variable.
- name string
Name of the variable.
- type string
Type of browser test variable. Valid values are
element,email,global,javascript,text.- example string
Example for the variable.
- id string
ID of the global variable to use. This is actually only used (and required) in the case of using a variable of type
global.- pattern string
Pattern of the variable.
- name str
Name of the variable.
- type str
Type of browser test variable. Valid values are
element,email,global,javascript,text.- example str
Example for the variable.
- id str
ID of the global variable to use. This is actually only used (and required) in the case of using a variable of type
global.- pattern str
Pattern of the variable.
- name String
Name of the variable.
- type String
Type of browser test variable. Valid values are
element,email,global,javascript,text.- example String
Example for the variable.
- id String
ID of the global variable to use. This is actually only used (and required) in the case of using a variable of type
global.- pattern String
Pattern of the variable.
SyntheticsTestConfigVariable
SyntheticsTestOptionsList
- Tick
Every int How often the test should run (in seconds).
- Accept
Self boolSigned For SSL test, whether or not the test should allow self signed certificates.
- Allow
Insecure bool Allows loading insecure content for an HTTP test.
- Check
Certificate boolRevocation For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
- Ci
Synthetics
Test Options List Ci CI/CD options for a Synthetic test.
- 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 a Synthetics API test. Valid values are
http1,http2,any.- Ignore
Server boolCertificate Error Ignore server certificate error.
- int
Timeout before declaring the initial step as failed (in seconds) for browser tests.
- Min
Failure intDuration Minimum amount of time in failure required to trigger an alert (in seconds). Default is
0.- Min
Location intFailed Minimum number of locations in failure required to trigger an alert. Default is
1.- Monitor
Name string The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
- Monitor
Options SyntheticsTest Options List Monitor Options - Monitor
Priority int - 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.
- Retry
Synthetics
Test Options List Retry - Rum
Settings SyntheticsTest Options List Rum Settings The RUM data collection settings for the Synthetic browser test.
- Scheduling
Synthetics
Test Options List Scheduling Object containing timeframes and timezone used for advanced scheduling.
- Tick
Every int How often the test should run (in seconds).
- Accept
Self boolSigned For SSL test, whether or not the test should allow self signed certificates.
- Allow
Insecure bool Allows loading insecure content for an HTTP test.
- Check
Certificate boolRevocation For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
- Ci
Synthetics
Test Options List Ci CI/CD options for a Synthetic test.
- 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 a Synthetics API test. Valid values are
http1,http2,any.- Ignore
Server boolCertificate Error Ignore server certificate error.
- int
Timeout before declaring the initial step as failed (in seconds) for browser tests.
- Min
Failure intDuration Minimum amount of time in failure required to trigger an alert (in seconds). Default is
0.- Min
Location intFailed Minimum number of locations in failure required to trigger an alert. Default is
1.- Monitor
Name string The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
- Monitor
Options SyntheticsTest Options List Monitor Options - Monitor
Priority int - No
Screenshot bool Prevents saving screenshots of the steps.
- Restricted
Roles []string A list of role identifiers pulled from the Roles API to restrict read and write access.
- Retry
Synthetics
Test Options List Retry - Rum
Settings SyntheticsTest Options List Rum Settings The RUM data collection settings for the Synthetic browser test.
- Scheduling
Synthetics
Test Options List Scheduling Object containing timeframes and timezone used for advanced scheduling.
- tick
Every Integer How often the test should run (in seconds).
- accept
Self BooleanSigned For SSL test, whether or not the test should allow self signed certificates.
- allow
Insecure Boolean Allows loading insecure content for an HTTP test.
- check
Certificate BooleanRevocation For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
- ci
Synthetics
Test Options List Ci CI/CD options for a Synthetic test.
- disable
Cors Boolean Disable Cross-Origin Resource Sharing for browser tests.
- disable
Csp Boolean Disable Content Security Policy for browser tests.
- follow
Redirects Boolean Determines whether or not the API HTTP test should follow redirects.
- http
Version String HTTP version to use for a Synthetics API test. Valid values are
http1,http2,any.- ignore
Server BooleanCertificate Error Ignore server certificate error.
- Integer
Timeout before declaring the initial step as failed (in seconds) for browser tests.
- min
Failure IntegerDuration Minimum amount of time in failure required to trigger an alert (in seconds). Default is
0.- min
Location IntegerFailed Minimum number of locations in failure required to trigger an alert. Default is
1.- monitor
Name String The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
- monitor
Options SyntheticsTest Options List Monitor Options - monitor
Priority Integer - no
Screenshot Boolean 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.
- retry
Synthetics
Test Options List Retry - rum
Settings SyntheticsTest Options List Rum Settings The RUM data collection settings for the Synthetic browser test.
- scheduling
Synthetics
Test Options List Scheduling Object containing timeframes and timezone used for advanced scheduling.
- tick
Every number How often the test should run (in seconds).
- accept
Self booleanSigned For SSL test, whether or not the test should allow self signed certificates.
- allow
Insecure boolean Allows loading insecure content for an HTTP test.
- check
Certificate booleanRevocation For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
- ci
Synthetics
Test Options List Ci CI/CD options for a Synthetic test.
- disable
Cors boolean Disable Cross-Origin Resource Sharing for browser tests.
- disable
Csp boolean Disable Content Security Policy for browser tests.
- follow
Redirects boolean Determines whether or not the API HTTP test should follow redirects.
- http
Version string HTTP version to use for a Synthetics API test. Valid values are
http1,http2,any.- ignore
Server booleanCertificate Error Ignore server certificate error.
- number
Timeout before declaring the initial step as failed (in seconds) for browser tests.
- min
Failure numberDuration Minimum amount of time in failure required to trigger an alert (in seconds). Default is
0.- min
Location numberFailed Minimum number of locations in failure required to trigger an alert. Default is
1.- monitor
Name string The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
- monitor
Options SyntheticsTest Options List Monitor Options - monitor
Priority number - no
Screenshot boolean Prevents saving screenshots of the steps.
- restricted
Roles string[] A list of role identifiers pulled from the Roles API to restrict read and write access.
- retry
Synthetics
Test Options List Retry - rum
Settings SyntheticsTest Options List Rum Settings The RUM data collection settings for the Synthetic browser test.
- scheduling
Synthetics
Test Options List Scheduling Object containing timeframes and timezone used for advanced scheduling.
- tick_
every int How often the test should run (in seconds).
- accept_
self_ boolsigned For SSL test, whether or not the test should allow self signed certificates.
- allow_
insecure bool Allows loading insecure content for an HTTP test.
- check_
certificate_ boolrevocation For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
- ci
Synthetics
Test Options List Ci CI/CD options for a Synthetic test.
- 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 a Synthetics API test. Valid values are
http1,http2,any.- ignore_
server_ boolcertificate_ error Ignore server certificate error.
- int
Timeout before declaring the initial step as failed (in seconds) for browser tests.
- min_
failure_ intduration Minimum amount of time in failure required to trigger an alert (in seconds). Default is
0.- min_
location_ intfailed Minimum number of locations in failure required to trigger an alert. Default is
1.- monitor_
name str The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
- monitor_
options SyntheticsTest Options List Monitor Options - monitor_
priority int - 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.
- retry
Synthetics
Test Options List Retry - rum_
settings SyntheticsTest Options List Rum Settings The RUM data collection settings for the Synthetic browser test.
- scheduling
Synthetics
Test Options List Scheduling Object containing timeframes and timezone used for advanced scheduling.
- tick
Every Number How often the test should run (in seconds).
- accept
Self BooleanSigned For SSL test, whether or not the test should allow self signed certificates.
- allow
Insecure Boolean Allows loading insecure content for an HTTP test.
- check
Certificate BooleanRevocation For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
- ci Property Map
CI/CD options for a Synthetic test.
- disable
Cors Boolean Disable Cross-Origin Resource Sharing for browser tests.
- disable
Csp Boolean Disable Content Security Policy for browser tests.
- follow
Redirects Boolean Determines whether or not the API HTTP test should follow redirects.
- http
Version String HTTP version to use for a Synthetics API test. Valid values are
http1,http2,any.- ignore
Server BooleanCertificate Error Ignore server certificate error.
- Number
Timeout before declaring the initial step as failed (in seconds) for browser tests.
- min
Failure NumberDuration Minimum amount of time in failure required to trigger an alert (in seconds). Default is
0.- min
Location NumberFailed Minimum number of locations in failure required to trigger an alert. Default is
1.- monitor
Name String The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
- monitor
Options Property Map - monitor
Priority Number - no
Screenshot Boolean 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.
- retry Property Map
- rum
Settings Property Map The RUM data collection settings for the Synthetic browser test.
- scheduling Property Map
Object containing timeframes and timezone used for advanced scheduling.
SyntheticsTestOptionsListCi
- Execution
Rule string
- Execution
Rule string
- execution
Rule String
- execution
Rule string
- execution_
rule str
- execution
Rule String
SyntheticsTestOptionsListMonitorOptions
- Renotify
Interval int
- Renotify
Interval int
- renotify
Interval Integer
- renotify
Interval number
- renotify
Interval Number
SyntheticsTestOptionsListRetry
SyntheticsTestOptionsListRumSettings
- Is
Enabled bool - Application
Id string - Client
Token intId
- Is
Enabled bool - Application
Id string - Client
Token intId
- is
Enabled Boolean - application
Id String - client
Token IntegerId
- is
Enabled boolean - application
Id string - client
Token numberId
- is_
enabled bool - application_
id str - client_
token_ intid
- is
Enabled Boolean - application
Id String - client
Token NumberId
SyntheticsTestOptionsListScheduling
SyntheticsTestOptionsListSchedulingTimeframe
SyntheticsTestRequestBasicauth
- Access
Key string Access key for
SIGV4authentication.- Access
Token stringUrl Access token url for
oauth-clientoroauth-ropauthentication.- Audience string
Audience for
oauth-clientoroauth-ropauthentication.- Client
Id string Client ID for
oauth-clientoroauth-ropauthentication.- Client
Secret string Client secret for
oauth-clientoroauth-ropauthentication.- Domain string
Domain for
ntlmauthentication.- Password string
Password for authentication.
- Region string
Region for
SIGV4authentication.- Resource string
Resource for
oauth-clientoroauth-ropauthentication.- Scope string
Scope for
oauth-clientoroauth-ropauthentication.- Secret
Key string Secret key for
SIGV4authentication.- Service
Name string Service name for
SIGV4authentication.- Session
Token string Session token for
SIGV4authentication.- Token
Api stringAuthentication Token API Authentication for
oauth-clientoroauth-ropauthentication. Valid values areheader,body.- Type string
Type of basic authentication to use when performing the test.
- Username string
Username for authentication.
- Workstation string
Workstation for
ntlmauthentication.
- Access
Key string Access key for
SIGV4authentication.- Access
Token stringUrl Access token url for
oauth-clientoroauth-ropauthentication.- Audience string
Audience for
oauth-clientoroauth-ropauthentication.- Client
Id string Client ID for
oauth-clientoroauth-ropauthentication.- Client
Secret string Client secret for
oauth-clientoroauth-ropauthentication.- Domain string
Domain for
ntlmauthentication.- Password string
Password for authentication.
- Region string
Region for
SIGV4authentication.- Resource string
Resource for
oauth-clientoroauth-ropauthentication.- Scope string
Scope for
oauth-clientoroauth-ropauthentication.- Secret
Key string Secret key for
SIGV4authentication.- Service
Name string Service name for
SIGV4authentication.- Session
Token string Session token for
SIGV4authentication.- Token
Api stringAuthentication Token API Authentication for
oauth-clientoroauth-ropauthentication. Valid values areheader,body.- Type string
Type of basic authentication to use when performing the test.
- Username string
Username for authentication.
- Workstation string
Workstation for
ntlmauthentication.
- access
Key String Access key for
SIGV4authentication.- access
Token StringUrl Access token url for
oauth-clientoroauth-ropauthentication.- audience String
Audience for
oauth-clientoroauth-ropauthentication.- client
Id String Client ID for
oauth-clientoroauth-ropauthentication.- client
Secret String Client secret for
oauth-clientoroauth-ropauthentication.- domain String
Domain for
ntlmauthentication.- password String
Password for authentication.
- region String
Region for
SIGV4authentication.- resource String
Resource for
oauth-clientoroauth-ropauthentication.- scope String
Scope for
oauth-clientoroauth-ropauthentication.- secret
Key String Secret key for
SIGV4authentication.- service
Name String Service name for
SIGV4authentication.- session
Token String Session token for
SIGV4authentication.- token
Api StringAuthentication Token API Authentication for
oauth-clientoroauth-ropauthentication. Valid values areheader,body.- type String
Type of basic authentication to use when performing the test.
- username String
Username for authentication.
- workstation String
Workstation for
ntlmauthentication.
- access
Key string Access key for
SIGV4authentication.- access
Token stringUrl Access token url for
oauth-clientoroauth-ropauthentication.- audience string
Audience for
oauth-clientoroauth-ropauthentication.- client
Id string Client ID for
oauth-clientoroauth-ropauthentication.- client
Secret string Client secret for
oauth-clientoroauth-ropauthentication.- domain string
Domain for
ntlmauthentication.- password string
Password for authentication.
- region string
Region for
SIGV4authentication.- resource string
Resource for
oauth-clientoroauth-ropauthentication.- scope string
Scope for
oauth-clientoroauth-ropauthentication.- secret
Key string Secret key for
SIGV4authentication.- service
Name string Service name for
SIGV4authentication.- session
Token string Session token for
SIGV4authentication.- token
Api stringAuthentication Token API Authentication for
oauth-clientoroauth-ropauthentication. Valid values areheader,body.- type string
Type of basic authentication to use when performing the test.
- username string
Username for authentication.
- workstation string
Workstation for
ntlmauthentication.
- access_
key str Access key for
SIGV4authentication.- access_
token_ strurl Access token url for
oauth-clientoroauth-ropauthentication.- audience str
Audience for
oauth-clientoroauth-ropauthentication.- client_
id str Client ID for
oauth-clientoroauth-ropauthentication.- client_
secret str Client secret for
oauth-clientoroauth-ropauthentication.- domain str
Domain for
ntlmauthentication.- password str
Password for authentication.
- region str
Region for
SIGV4authentication.- resource str
Resource for
oauth-clientoroauth-ropauthentication.- scope str
Scope for
oauth-clientoroauth-ropauthentication.- secret_
key str Secret key for
SIGV4authentication.- service_
name str Service name for
SIGV4authentication.- session_
token str Session token for
SIGV4authentication.- token_
api_ strauthentication Token API Authentication for
oauth-clientoroauth-ropauthentication. Valid values areheader,body.- type str
Type of basic authentication to use when performing the test.
- username str
Username for authentication.
- workstation str
Workstation for
ntlmauthentication.
- access
Key String Access key for
SIGV4authentication.- access
Token StringUrl Access token url for
oauth-clientoroauth-ropauthentication.- audience String
Audience for
oauth-clientoroauth-ropauthentication.- client
Id String Client ID for
oauth-clientoroauth-ropauthentication.- client
Secret String Client secret for
oauth-clientoroauth-ropauthentication.- domain String
Domain for
ntlmauthentication.- password String
Password for authentication.
- region String
Region for
SIGV4authentication.- resource String
Resource for
oauth-clientoroauth-ropauthentication.- scope String
Scope for
oauth-clientoroauth-ropauthentication.- secret
Key String Secret key for
SIGV4authentication.- service
Name String Service name for
SIGV4authentication.- session
Token String Session token for
SIGV4authentication.- token
Api StringAuthentication Token API Authentication for
oauth-clientoroauth-ropauthentication. Valid values areheader,body.- type String
Type of basic authentication to use when performing the test.
- username String
Username for authentication.
- workstation String
Workstation for
ntlmauthentication.
SyntheticsTestRequestClientCertificate
SyntheticsTestRequestClientCertificateCert
SyntheticsTestRequestClientCertificateKey
SyntheticsTestRequestDefinition
- Body string
The request body.
- Body
Type string Type of the request body. Valid values are
text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql.- Call
Type string The type of gRPC call to perform. Valid values are
healthcheck,unary.- Certificate
Domains List<string> By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in
certificate_domains.- Dns
Server string DNS server to use for DNS tests (
subtype = "dns").- Dns
Server intPort DNS server port to use for DNS tests.
- Host string
Host name to perform the test with.
- Message string
For UDP and websocket tests, message to send with the request.
- Method string
Either the HTTP method/verb to use or a gRPC method available on the service set in the
servicefield. Required ifsubtypeisHTTPor ifsubtypeisgrpcandcallTypeisunary.- No
Saving boolResponse Body Determines whether or not to save the response body.
- Number
Of intPackets Number of pings to use per test for ICMP tests (
subtype = "icmp") between 0 and 10.- Port int
Port to use when performing the test.
- Servername string
For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.
- Service string
The gRPC service on which you want to perform the gRPC call.
- Should
Track boolHops This will turn on a traceroute probe to discover all gateways along the path to the host destination. For ICMP tests (
subtype = "icmp").- Timeout int
Timeout in seconds for the test. Defaults to
60.- Url string
The URL to send the request to.
- Body string
The request body.
- Body
Type string Type of the request body. Valid values are
text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql.- Call
Type string The type of gRPC call to perform. Valid values are
healthcheck,unary.- Certificate
Domains []string By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in
certificate_domains.- Dns
Server string DNS server to use for DNS tests (
subtype = "dns").- Dns
Server intPort DNS server port to use for DNS tests.
- Host string
Host name to perform the test with.
- Message string
For UDP and websocket tests, message to send with the request.
- Method string
Either the HTTP method/verb to use or a gRPC method available on the service set in the
servicefield. Required ifsubtypeisHTTPor ifsubtypeisgrpcandcallTypeisunary.- No
Saving boolResponse Body Determines whether or not to save the response body.
- Number
Of intPackets Number of pings to use per test for ICMP tests (
subtype = "icmp") between 0 and 10.- Port int
Port to use when performing the test.
- Servername string
For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.
- Service string
The gRPC service on which you want to perform the gRPC call.
- Should
Track boolHops This will turn on a traceroute probe to discover all gateways along the path to the host destination. For ICMP tests (
subtype = "icmp").- Timeout int
Timeout in seconds for the test. Defaults to
60.- Url string
The URL to send the request to.
- body String
The request body.
- body
Type String Type of the request body. Valid values are
text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql.- call
Type String The type of gRPC call to perform. Valid values are
healthcheck,unary.- certificate
Domains List<String> By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in
certificate_domains.- dns
Server String DNS server to use for DNS tests (
subtype = "dns").- dns
Server IntegerPort DNS server port to use for DNS tests.
- host String
Host name to perform the test with.
- message String
For UDP and websocket tests, message to send with the request.
- method String
Either the HTTP method/verb to use or a gRPC method available on the service set in the
servicefield. Required ifsubtypeisHTTPor ifsubtypeisgrpcandcallTypeisunary.- no
Saving BooleanResponse Body Determines whether or not to save the response body.
- number
Of IntegerPackets Number of pings to use per test for ICMP tests (
subtype = "icmp") between 0 and 10.- port Integer
Port to use when performing the test.
- servername String
For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.
- service String
The gRPC service on which you want to perform the gRPC call.
- should
Track BooleanHops This will turn on a traceroute probe to discover all gateways along the path to the host destination. For ICMP tests (
subtype = "icmp").- timeout Integer
Timeout in seconds for the test. Defaults to
60.- url String
The URL to send the request to.
- body string
The request body.
- body
Type string Type of the request body. Valid values are
text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql.- call
Type string The type of gRPC call to perform. Valid values are
healthcheck,unary.- certificate
Domains string[] By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in
certificate_domains.- dns
Server string DNS server to use for DNS tests (
subtype = "dns").- dns
Server numberPort DNS server port to use for DNS tests.
- host string
Host name to perform the test with.
- message string
For UDP and websocket tests, message to send with the request.
- method string
Either the HTTP method/verb to use or a gRPC method available on the service set in the
servicefield. Required ifsubtypeisHTTPor ifsubtypeisgrpcandcallTypeisunary.- no
Saving booleanResponse Body Determines whether or not to save the response body.
- number
Of numberPackets Number of pings to use per test for ICMP tests (
subtype = "icmp") between 0 and 10.- port number
Port to use when performing the test.
- servername string
For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.
- service string
The gRPC service on which you want to perform the gRPC call.
- should
Track booleanHops This will turn on a traceroute probe to discover all gateways along the path to the host destination. For ICMP tests (
subtype = "icmp").- timeout number
Timeout in seconds for the test. Defaults to
60.- url string
The URL to send the request to.
- body str
The request body.
- body_
type str Type of the request body. Valid values are
text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql.- call_
type str The type of gRPC call to perform. Valid values are
healthcheck,unary.- certificate_
domains Sequence[str] By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in
certificate_domains.- dns_
server str DNS server to use for DNS tests (
subtype = "dns").- dns_
server_ intport DNS server port to use for DNS tests.
- host str
Host name to perform the test with.
- message str
For UDP and websocket tests, message to send with the request.
- method str
Either the HTTP method/verb to use or a gRPC method available on the service set in the
servicefield. Required ifsubtypeisHTTPor ifsubtypeisgrpcandcallTypeisunary.- no_
saving_ boolresponse_ body Determines whether or not to save the response body.
- number_
of_ intpackets Number of pings to use per test for ICMP tests (
subtype = "icmp") between 0 and 10.- port int
Port to use when performing the test.
- servername str
For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.
- service str
The gRPC service on which you want to perform the gRPC call.
- should_
track_ boolhops This will turn on a traceroute probe to discover all gateways along the path to the host destination. For ICMP tests (
subtype = "icmp").- timeout int
Timeout in seconds for the test. Defaults to
60.- url str
The URL to send the request to.
- body String
The request body.
- body
Type String Type of the request body. Valid values are
text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql.- call
Type String The type of gRPC call to perform. Valid values are
healthcheck,unary.- certificate
Domains List<String> By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in
certificate_domains.- dns
Server String DNS server to use for DNS tests (
subtype = "dns").- dns
Server NumberPort DNS server port to use for DNS tests.
- host String
Host name to perform the test with.
- message String
For UDP and websocket tests, message to send with the request.
- method String
Either the HTTP method/verb to use or a gRPC method available on the service set in the
servicefield. Required ifsubtypeisHTTPor ifsubtypeisgrpcandcallTypeisunary.- no
Saving BooleanResponse Body Determines whether or not to save the response body.
- number
Of NumberPackets Number of pings to use per test for ICMP tests (
subtype = "icmp") between 0 and 10.- port Number
Port to use when performing the test.
- servername String
For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.
- service String
The gRPC service on which you want to perform the gRPC call.
- should
Track BooleanHops This will turn on a traceroute probe to discover all gateways along the path to the host destination. For ICMP tests (
subtype = "icmp").- timeout Number
Timeout in seconds for the test. Defaults to
60.- url String
The URL to send the request to.
SyntheticsTestRequestProxy
Import
Synthetics tests can be imported using their public string ID, e.g.
$ pulumi import datadog:index/syntheticsTest:SyntheticsTest fizz abc-123-xyz
Package Details
- Repository
- Datadog pulumi/pulumi-datadog
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
datadogTerraform Provider.