Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Checkly
  3. API Docs
  4. Check
Checkly v2.1.1 published on Tuesday, Mar 11, 2025 by Checkly
checkly/pulumi-checkly

checkly.Check

Explore with Pulumi AI

checkly logo
Checkly v2.1.1 published on Tuesday, Mar 11, 2025 by Checkly
checkly/pulumi-checkly

    Checks allows you to monitor key webapp flows, backend API’s and set up alerting, so you get a notification when things break or slow down.

    Create Check Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Check(name: string, args: CheckArgs, opts?: CustomResourceOptions);
    @overload
def Check(resource_name: str,
          args: CheckArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Check(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          frequency: Optional[int] = None,
          type: Optional[str] = None,
          activated: Optional[bool] = None,
          max_response_time: Optional[int] = None,
          name: Optional[str] = None,
          environment_variable: Optional[Sequence[CheckEnvironmentVariableArgs]] = None,
          environment_variables: Optional[Mapping[str, str]] = None,
          degraded_response_time: Optional[int] = None,
          frequency_offset: Optional[int] = None,
          group_id: Optional[int] = None,
          group_order: Optional[int] = None,
          local_setup_script: Optional[str] = None,
          local_teardown_script: Optional[str] = None,
          locations: Optional[Sequence[str]] = None,
          alert_settings: Optional[CheckAlertSettingsArgs] = None,
          muted: Optional[bool] = None,
          double_check: Optional[bool] = None,
          private_locations: Optional[Sequence[str]] = None,
          request: Optional[CheckRequestArgs] = None,
          retry_strategy: Optional[CheckRetryStrategyArgs] = None,
          run_parallel: Optional[bool] = None,
          runtime_id: Optional[str] = None,
          script: Optional[str] = None,
          setup_snippet_id: Optional[int] = None,
          should_fail: Optional[bool] = None,
          ssl_check: Optional[bool] = None,
          ssl_check_domain: Optional[str] = None,
          tags: Optional[Sequence[str]] = None,
          teardown_snippet_id: Optional[int] = None,
          alert_channel_subscriptions: Optional[Sequence[CheckAlertChannelSubscriptionArgs]] = None,
          use_global_alert_settings: Optional[bool] = None)
    func NewCheck(ctx *Context, name string, args CheckArgs, opts ...ResourceOption) (*Check, error)
    public Check(string name, CheckArgs args, CustomResourceOptions? opts = null)
    public Check(String name, CheckArgs args)
public Check(String name, CheckArgs args, CustomResourceOptions options)

    type: checkly:Check
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args CheckArgs
    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 CheckArgs
    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 CheckArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CheckArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CheckArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var checkResource = new Checkly.Check("checkResource", new()
{
    Frequency = 0,
    Type = "string",
    Activated = false,
    MaxResponseTime = 0,
    Name = "string",
    EnvironmentVariable = new[]
    {
        new Checkly.Inputs.CheckEnvironmentVariableArgs
        {
            Key = "string",
            Value = "string",
            Locked = false,
            Secret = false,
        },
    },
    DegradedResponseTime = 0,
    FrequencyOffset = 0,
    GroupId = 0,
    GroupOrder = 0,
    LocalSetupScript = "string",
    LocalTeardownScript = "string",
    Locations = new[]
    {
        "string",
    },
    AlertSettings = new Checkly.Inputs.CheckAlertSettingsArgs
    {
        EscalationType = "string",
        ParallelRunFailureThresholds = new[]
        {
            new Checkly.Inputs.CheckAlertSettingsParallelRunFailureThresholdArgs
            {
                Enabled = false,
                Percentage = 0,
            },
        },
        Reminders = new[]
        {
            new Checkly.Inputs.CheckAlertSettingsReminderArgs
            {
                Amount = 0,
                Interval = 0,
            },
        },
        RunBasedEscalations = new[]
        {
            new Checkly.Inputs.CheckAlertSettingsRunBasedEscalationArgs
            {
                FailedRunThreshold = 0,
            },
        },
        TimeBasedEscalations = new[]
        {
            new Checkly.Inputs.CheckAlertSettingsTimeBasedEscalationArgs
            {
                MinutesFailingThreshold = 0,
            },
        },
    },
    Muted = false,
    PrivateLocations = new[]
    {
        "string",
    },
    Request = new Checkly.Inputs.CheckRequestArgs
    {
        Url = "string",
        Assertions = new[]
        {
            new Checkly.Inputs.CheckRequestAssertionArgs
            {
                Comparison = "string",
                Source = "string",
                Property = "string",
                Target = "string",
            },
        },
        BasicAuth = new Checkly.Inputs.CheckRequestBasicAuthArgs
        {
            Password = "string",
            Username = "string",
        },
        Body = "string",
        BodyType = "string",
        FollowRedirects = false,
        Headers = 
        {
            { "string", "string" },
        },
        IpFamily = "string",
        Method = "string",
        QueryParameters = 
        {
            { "string", "string" },
        },
        SkipSsl = false,
    },
    RetryStrategy = new Checkly.Inputs.CheckRetryStrategyArgs
    {
        Type = "string",
        BaseBackoffSeconds = 0,
        MaxDurationSeconds = 0,
        MaxRetries = 0,
        SameRegion = false,
    },
    RunParallel = false,
    RuntimeId = "string",
    Script = "string",
    SetupSnippetId = 0,
    ShouldFail = false,
    SslCheckDomain = "string",
    Tags = new[]
    {
        "string",
    },
    TeardownSnippetId = 0,
    AlertChannelSubscriptions = new[]
    {
        new Checkly.Inputs.CheckAlertChannelSubscriptionArgs
        {
            Activated = false,
            ChannelId = 0,
        },
    },
    UseGlobalAlertSettings = false,
});

    example, err := checkly.NewCheck(ctx, "checkResource", &checkly.CheckArgs{
	Frequency:       pulumi.Int(0),
	Type:            pulumi.String("string"),
	Activated:       pulumi.Bool(false),
	MaxResponseTime: pulumi.Int(0),
	Name:            pulumi.String("string"),
	EnvironmentVariable: checkly.CheckEnvironmentVariableArray{
		&checkly.CheckEnvironmentVariableArgs{
			Key:    pulumi.String("string"),
			Value:  pulumi.String("string"),
			Locked: pulumi.Bool(false),
			Secret: pulumi.Bool(false),
		},
	},
	DegradedResponseTime: pulumi.Int(0),
	FrequencyOffset:      pulumi.Int(0),
	GroupId:              pulumi.Int(0),
	GroupOrder:           pulumi.Int(0),
	LocalSetupScript:     pulumi.String("string"),
	LocalTeardownScript:  pulumi.String("string"),
	Locations: pulumi.StringArray{
		pulumi.String("string"),
	},
	AlertSettings: &checkly.CheckAlertSettingsArgs{
		EscalationType: pulumi.String("string"),
		ParallelRunFailureThresholds: checkly.CheckAlertSettingsParallelRunFailureThresholdArray{
			&checkly.CheckAlertSettingsParallelRunFailureThresholdArgs{
				Enabled:    pulumi.Bool(false),
				Percentage: pulumi.Int(0),
			},
		},
		Reminders: checkly.CheckAlertSettingsReminderArray{
			&checkly.CheckAlertSettingsReminderArgs{
				Amount:   pulumi.Int(0),
				Interval: pulumi.Int(0),
			},
		},
		RunBasedEscalations: checkly.CheckAlertSettingsRunBasedEscalationArray{
			&checkly.CheckAlertSettingsRunBasedEscalationArgs{
				FailedRunThreshold: pulumi.Int(0),
			},
		},
		TimeBasedEscalations: checkly.CheckAlertSettingsTimeBasedEscalationArray{
			&checkly.CheckAlertSettingsTimeBasedEscalationArgs{
				MinutesFailingThreshold: pulumi.Int(0),
			},
		},
	},
	Muted: pulumi.Bool(false),
	PrivateLocations: pulumi.StringArray{
		pulumi.String("string"),
	},
	Request: &checkly.CheckRequestArgs{
		Url: pulumi.String("string"),
		Assertions: checkly.CheckRequestAssertionArray{
			&checkly.CheckRequestAssertionArgs{
				Comparison: pulumi.String("string"),
				Source:     pulumi.String("string"),
				Property:   pulumi.String("string"),
				Target:     pulumi.String("string"),
			},
		},
		BasicAuth: &checkly.CheckRequestBasicAuthArgs{
			Password: pulumi.String("string"),
			Username: pulumi.String("string"),
		},
		Body:            pulumi.String("string"),
		BodyType:        pulumi.String("string"),
		FollowRedirects: pulumi.Bool(false),
		Headers: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		IpFamily: pulumi.String("string"),
		Method:   pulumi.String("string"),
		QueryParameters: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		SkipSsl: pulumi.Bool(false),
	},
	RetryStrategy: &checkly.CheckRetryStrategyArgs{
		Type:               pulumi.String("string"),
		BaseBackoffSeconds: pulumi.Int(0),
		MaxDurationSeconds: pulumi.Int(0),
		MaxRetries:         pulumi.Int(0),
		SameRegion:         pulumi.Bool(false),
	},
	RunParallel:    pulumi.Bool(false),
	RuntimeId:      pulumi.String("string"),
	Script:         pulumi.String("string"),
	SetupSnippetId: pulumi.Int(0),
	ShouldFail:     pulumi.Bool(false),
	SslCheckDomain: pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	TeardownSnippetId: pulumi.Int(0),
	AlertChannelSubscriptions: checkly.CheckAlertChannelSubscriptionArray{
		&checkly.CheckAlertChannelSubscriptionArgs{
			Activated: pulumi.Bool(false),
			ChannelId: pulumi.Int(0),
		},
	},
	UseGlobalAlertSettings: pulumi.Bool(false),
})

    var checkResource = new Check("checkResource", CheckArgs.builder()
    .frequency(0)
    .type("string")
    .activated(false)
    .maxResponseTime(0)
    .name("string")
    .environmentVariable(CheckEnvironmentVariableArgs.builder()
        .key("string")
        .value("string")
        .locked(false)
        .secret(false)
        .build())
    .degradedResponseTime(0)
    .frequencyOffset(0)
    .groupId(0)
    .groupOrder(0)
    .localSetupScript("string")
    .localTeardownScript("string")
    .locations("string")
    .alertSettings(CheckAlertSettingsArgs.builder()
        .escalationType("string")
        .parallelRunFailureThresholds(CheckAlertSettingsParallelRunFailureThresholdArgs.builder()
            .enabled(false)
            .percentage(0)
            .build())
        .reminders(CheckAlertSettingsReminderArgs.builder()
            .amount(0)
            .interval(0)
            .build())
        .runBasedEscalations(CheckAlertSettingsRunBasedEscalationArgs.builder()
            .failedRunThreshold(0)
            .build())
        .timeBasedEscalations(CheckAlertSettingsTimeBasedEscalationArgs.builder()
            .minutesFailingThreshold(0)
            .build())
        .build())
    .muted(false)
    .privateLocations("string")
    .request(CheckRequestArgs.builder()
        .url("string")
        .assertions(CheckRequestAssertionArgs.builder()
            .comparison("string")
            .source("string")
            .property("string")
            .target("string")
            .build())
        .basicAuth(CheckRequestBasicAuthArgs.builder()
            .password("string")
            .username("string")
            .build())
        .body("string")
        .bodyType("string")
        .followRedirects(false)
        .headers(Map.of("string", "string"))
        .ipFamily("string")
        .method("string")
        .queryParameters(Map.of("string", "string"))
        .skipSsl(false)
        .build())
    .retryStrategy(CheckRetryStrategyArgs.builder()
        .type("string")
        .baseBackoffSeconds(0)
        .maxDurationSeconds(0)
        .maxRetries(0)
        .sameRegion(false)
        .build())
    .runParallel(false)
    .runtimeId("string")
    .script("string")
    .setupSnippetId(0)
    .shouldFail(false)
    .sslCheckDomain("string")
    .tags("string")
    .teardownSnippetId(0)
    .alertChannelSubscriptions(CheckAlertChannelSubscriptionArgs.builder()
        .activated(false)
        .channelId(0)
        .build())
    .useGlobalAlertSettings(false)
    .build());

    check_resource = checkly.Check("checkResource",
    frequency=0,
    type="string",
    activated=False,
    max_response_time=0,
    name="string",
    environment_variable=[{
        "key": "string",
        "value": "string",
        "locked": False,
        "secret": False,
    }],
    degraded_response_time=0,
    frequency_offset=0,
    group_id=0,
    group_order=0,
    local_setup_script="string",
    local_teardown_script="string",
    locations=["string"],
    alert_settings={
        "escalation_type": "string",
        "parallel_run_failure_thresholds": [{
            "enabled": False,
            "percentage": 0,
        }],
        "reminders": [{
            "amount": 0,
            "interval": 0,
        }],
        "run_based_escalations": [{
            "failed_run_threshold": 0,
        }],
        "time_based_escalations": [{
            "minutes_failing_threshold": 0,
        }],
    },
    muted=False,
    private_locations=["string"],
    request={
        "url": "string",
        "assertions": [{
            "comparison": "string",
            "source": "string",
            "property": "string",
            "target": "string",
        }],
        "basic_auth": {
            "password": "string",
            "username": "string",
        },
        "body": "string",
        "body_type": "string",
        "follow_redirects": False,
        "headers": {
            "string": "string",
        },
        "ip_family": "string",
        "method": "string",
        "query_parameters": {
            "string": "string",
        },
        "skip_ssl": False,
    },
    retry_strategy={
        "type": "string",
        "base_backoff_seconds": 0,
        "max_duration_seconds": 0,
        "max_retries": 0,
        "same_region": False,
    },
    run_parallel=False,
    runtime_id="string",
    script="string",
    setup_snippet_id=0,
    should_fail=False,
    ssl_check_domain="string",
    tags=["string"],
    teardown_snippet_id=0,
    alert_channel_subscriptions=[{
        "activated": False,
        "channel_id": 0,
    }],
    use_global_alert_settings=False)

    const checkResource = new checkly.Check("checkResource", {
    frequency: 0,
    type: "string",
    activated: false,
    maxResponseTime: 0,
    name: "string",
    environmentVariable: [{
        key: "string",
        value: "string",
        locked: false,
        secret: false,
    }],
    degradedResponseTime: 0,
    frequencyOffset: 0,
    groupId: 0,
    groupOrder: 0,
    localSetupScript: "string",
    localTeardownScript: "string",
    locations: ["string"],
    alertSettings: {
        escalationType: "string",
        parallelRunFailureThresholds: [{
            enabled: false,
            percentage: 0,
        }],
        reminders: [{
            amount: 0,
            interval: 0,
        }],
        runBasedEscalations: [{
            failedRunThreshold: 0,
        }],
        timeBasedEscalations: [{
            minutesFailingThreshold: 0,
        }],
    },
    muted: false,
    privateLocations: ["string"],
    request: {
        url: "string",
        assertions: [{
            comparison: "string",
            source: "string",
            property: "string",
            target: "string",
        }],
        basicAuth: {
            password: "string",
            username: "string",
        },
        body: "string",
        bodyType: "string",
        followRedirects: false,
        headers: {
            string: "string",
        },
        ipFamily: "string",
        method: "string",
        queryParameters: {
            string: "string",
        },
        skipSsl: false,
    },
    retryStrategy: {
        type: "string",
        baseBackoffSeconds: 0,
        maxDurationSeconds: 0,
        maxRetries: 0,
        sameRegion: false,
    },
    runParallel: false,
    runtimeId: "string",
    script: "string",
    setupSnippetId: 0,
    shouldFail: false,
    sslCheckDomain: "string",
    tags: ["string"],
    teardownSnippetId: 0,
    alertChannelSubscriptions: [{
        activated: false,
        channelId: 0,
    }],
    useGlobalAlertSettings: false,
});

    type: checkly:Check
properties:
    activated: false
    alertChannelSubscriptions:
        - activated: false
          channelId: 0
    alertSettings:
        escalationType: string
        parallelRunFailureThresholds:
            - enabled: false
              percentage: 0
        reminders:
            - amount: 0
              interval: 0
        runBasedEscalations:
            - failedRunThreshold: 0
        timeBasedEscalations:
            - minutesFailingThreshold: 0
    degradedResponseTime: 0
    environmentVariable:
        - key: string
          locked: false
          secret: false
          value: string
    frequency: 0
    frequencyOffset: 0
    groupId: 0
    groupOrder: 0
    localSetupScript: string
    localTeardownScript: string
    locations:
        - string
    maxResponseTime: 0
    muted: false
    name: string
    privateLocations:
        - string
    request:
        assertions:
            - comparison: string
              property: string
              source: string
              target: string
        basicAuth:
            password: string
            username: string
        body: string
        bodyType: string
        followRedirects: false
        headers:
            string: string
        ipFamily: string
        method: string
        queryParameters:
            string: string
        skipSsl: false
        url: string
    retryStrategy:
        baseBackoffSeconds: 0
        maxDurationSeconds: 0
        maxRetries: 0
        sameRegion: false
        type: string
    runParallel: false
    runtimeId: string
    script: string
    setupSnippetId: 0
    shouldFail: false
    sslCheckDomain: string
    tags:
        - string
    teardownSnippetId: 0
    type: string
    useGlobalAlertSettings: false

    Check Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Check resource accepts the following input properties:

    Activated bool
    Determines if the check is running or not. Possible values true, and false.
    Frequency int
    The frequency in minutes to run the check. Possible values are 0, 1, 2, 5, 10, 15, 30, 60, 120, 180, 360, 720, and 1440.
    Type string
    The type of the check. Possible values are API, BROWSER, and MULTI_STEP.
    AlertChannelSubscriptions List<CheckAlertChannelSubscription>
    An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your check, we won't be able to alert you in case something goes wrong with it.
    AlertSettings CheckAlertSettings
    DegradedResponseTime int
    The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 30000. (Default 15000).
    DoubleCheck bool
    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.

    Deprecated: The property double_check is deprecated and will be removed in a future version. To enable retries for failed check runs, use the retry_strategy property instead.

    EnvironmentVariable List<CheckEnvironmentVariable>
    Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden, add secret = true to create a secret variable. These are only relevant for browser checks. Use global environment variables whenever possible.
    EnvironmentVariables Dictionary<string, string>
    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated: The property environment_variables is deprecated and will be removed in a future version. Consider using the new environment_variable list.

    FrequencyOffset int
    This property only valid for API high frequency checks. To create a hight frequency check, the property frequency must be 0 and frequency_offset could be 10, 20 or 30.
    GroupId int
    The id of the check group this check is part of.
    GroupOrder int
    The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.
    LocalSetupScript string
    A valid piece of Node.js code to run in the setup phase.
    LocalTeardownScript string
    A valid piece of Node.js code to run in the teardown phase.
    Locations List<string>
    An array of one or more data center locations where to run the this check. (Default ["us-east-1"])
    MaxResponseTime int
    The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 30000. (Default 30000).
    Muted bool
    Determines if any notifications will be sent out when a check fails/degrades/recovers.
    Name string
    The name of the check.
    PrivateLocations List<string>
    An array of one or more private locations slugs.
    Request CheckRequest
    An API check might have one request config.
    RetryStrategy CheckRetryStrategy
    A strategy for retrying failed check runs.
    RunParallel bool
    Determines if the check should run in all selected locations in parallel or round-robin.
    RuntimeId string
    The id of the runtime to use for this check.
    Script string
    A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file.
    SetupSnippetId int
    An ID reference to a snippet to use in the setup phase of an API check.
    ShouldFail bool
    Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.
    SslCheck bool
    Determines if the SSL certificate should be validated for expiry.

    Deprecated: The property ssl_check is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.

    SslCheckDomain string
    A valid fully qualified domain name (FQDN) to check its SSL certificate.
    Tags List<string>
    A list of tags for organizing and filtering checks.
    TeardownSnippetId int
    An ID reference to a snippet to use in the teardown phase of an API check.
    UseGlobalAlertSettings bool
    When true, the account level alert settings will be used, not the alert setting defined on this check.
    Activated bool
    Determines if the check is running or not. Possible values true, and false.
    Frequency int
    The frequency in minutes to run the check. Possible values are 0, 1, 2, 5, 10, 15, 30, 60, 120, 180, 360, 720, and 1440.
    Type string
    The type of the check. Possible values are API, BROWSER, and MULTI_STEP.
    AlertChannelSubscriptions []CheckAlertChannelSubscriptionArgs
    An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your check, we won't be able to alert you in case something goes wrong with it.
    AlertSettings CheckAlertSettingsArgs
    DegradedResponseTime int
    The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 30000. (Default 15000).
    DoubleCheck bool
    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.

    Deprecated: The property double_check is deprecated and will be removed in a future version. To enable retries for failed check runs, use the retry_strategy property instead.

    EnvironmentVariable []CheckEnvironmentVariableArgs
    Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden, add secret = true to create a secret variable. These are only relevant for browser checks. Use global environment variables whenever possible.
    EnvironmentVariables map[string]string
    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated: The property environment_variables is deprecated and will be removed in a future version. Consider using the new environment_variable list.

    FrequencyOffset int
    This property only valid for API high frequency checks. To create a hight frequency check, the property frequency must be 0 and frequency_offset could be 10, 20 or 30.
    GroupId int
    The id of the check group this check is part of.
    GroupOrder int
    The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.
    LocalSetupScript string
    A valid piece of Node.js code to run in the setup phase.
    LocalTeardownScript string
    A valid piece of Node.js code to run in the teardown phase.
    Locations []string
    An array of one or more data center locations where to run the this check. (Default ["us-east-1"])
    MaxResponseTime int
    The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 30000. (Default 30000).
    Muted bool
    Determines if any notifications will be sent out when a check fails/degrades/recovers.
    Name string
    The name of the check.
    PrivateLocations []string
    An array of one or more private locations slugs.
    Request CheckRequestArgs
    An API check might have one request config.
    RetryStrategy CheckRetryStrategyArgs
    A strategy for retrying failed check runs.
    RunParallel bool
    Determines if the check should run in all selected locations in parallel or round-robin.
    RuntimeId string
    The id of the runtime to use for this check.
    Script string
    A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file.
    SetupSnippetId int
    An ID reference to a snippet to use in the setup phase of an API check.
    ShouldFail bool
    Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.
    SslCheck bool
    Determines if the SSL certificate should be validated for expiry.

    Deprecated: The property ssl_check is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.

    SslCheckDomain string
    A valid fully qualified domain name (FQDN) to check its SSL certificate.
    Tags []string
    A list of tags for organizing and filtering checks.
    TeardownSnippetId int
    An ID reference to a snippet to use in the teardown phase of an API check.
    UseGlobalAlertSettings bool
    When true, the account level alert settings will be used, not the alert setting defined on this check.
    activated Boolean
    Determines if the check is running or not. Possible values true, and false.
    frequency Integer
    The frequency in minutes to run the check. Possible values are 0, 1, 2, 5, 10, 15, 30, 60, 120, 180, 360, 720, and 1440.
    type String
    The type of the check. Possible values are API, BROWSER, and MULTI_STEP.
    alertChannelSubscriptions List<CheckAlertChannelSubscription>
    An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your check, we won't be able to alert you in case something goes wrong with it.
    alertSettings CheckAlertSettings
    degradedResponseTime Integer
    The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 30000. (Default 15000).
    doubleCheck Boolean
    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.

    Deprecated: The property double_check is deprecated and will be removed in a future version. To enable retries for failed check runs, use the retry_strategy property instead.

    environmentVariable List<CheckEnvironmentVariable>
    Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden, add secret = true to create a secret variable. These are only relevant for browser checks. Use global environment variables whenever possible.
    environmentVariables Map<String,String>
    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated: The property environment_variables is deprecated and will be removed in a future version. Consider using the new environment_variable list.

    frequencyOffset Integer
    This property only valid for API high frequency checks. To create a hight frequency check, the property frequency must be 0 and frequency_offset could be 10, 20 or 30.
    groupId Integer
    The id of the check group this check is part of.
    groupOrder Integer
    The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.
    localSetupScript String
    A valid piece of Node.js code to run in the setup phase.
    localTeardownScript String
    A valid piece of Node.js code to run in the teardown phase.
    locations List<String>
    An array of one or more data center locations where to run the this check. (Default ["us-east-1"])
    maxResponseTime Integer
    The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 30000. (Default 30000).
    muted Boolean
    Determines if any notifications will be sent out when a check fails/degrades/recovers.
    name String
    The name of the check.
    privateLocations List<String>
    An array of one or more private locations slugs.
    request CheckRequest
    An API check might have one request config.
    retryStrategy CheckRetryStrategy
    A strategy for retrying failed check runs.
    runParallel Boolean
    Determines if the check should run in all selected locations in parallel or round-robin.
    runtimeId String
    The id of the runtime to use for this check.
    script String
    A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file.
    setupSnippetId Integer
    An ID reference to a snippet to use in the setup phase of an API check.
    shouldFail Boolean
    Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.
    sslCheck Boolean
    Determines if the SSL certificate should be validated for expiry.

    Deprecated: The property ssl_check is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.

    sslCheckDomain String
    A valid fully qualified domain name (FQDN) to check its SSL certificate.
    tags List<String>
    A list of tags for organizing and filtering checks.
    teardownSnippetId Integer
    An ID reference to a snippet to use in the teardown phase of an API check.
    useGlobalAlertSettings Boolean
    When true, the account level alert settings will be used, not the alert setting defined on this check.
    activated boolean
    Determines if the check is running or not. Possible values true, and false.
    frequency number
    The frequency in minutes to run the check. Possible values are 0, 1, 2, 5, 10, 15, 30, 60, 120, 180, 360, 720, and 1440.
    type string
    The type of the check. Possible values are API, BROWSER, and MULTI_STEP.
    alertChannelSubscriptions CheckAlertChannelSubscription[]
    An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your check, we won't be able to alert you in case something goes wrong with it.
    alertSettings CheckAlertSettings
    degradedResponseTime number
    The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 30000. (Default 15000).
    doubleCheck boolean
    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.

    Deprecated: The property double_check is deprecated and will be removed in a future version. To enable retries for failed check runs, use the retry_strategy property instead.

    environmentVariable CheckEnvironmentVariable[]
    Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden, add secret = true to create a secret variable. These are only relevant for browser checks. Use global environment variables whenever possible.
    environmentVariables {[key: string]: string}
    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated: The property environment_variables is deprecated and will be removed in a future version. Consider using the new environment_variable list.

    frequencyOffset number
    This property only valid for API high frequency checks. To create a hight frequency check, the property frequency must be 0 and frequency_offset could be 10, 20 or 30.
    groupId number
    The id of the check group this check is part of.
    groupOrder number
    The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.
    localSetupScript string
    A valid piece of Node.js code to run in the setup phase.
    localTeardownScript string
    A valid piece of Node.js code to run in the teardown phase.
    locations string[]
    An array of one or more data center locations where to run the this check. (Default ["us-east-1"])
    maxResponseTime number
    The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 30000. (Default 30000).
    muted boolean
    Determines if any notifications will be sent out when a check fails/degrades/recovers.
    name string
    The name of the check.
    privateLocations string[]
    An array of one or more private locations slugs.
    request CheckRequest
    An API check might have one request config.
    retryStrategy CheckRetryStrategy
    A strategy for retrying failed check runs.
    runParallel boolean
    Determines if the check should run in all selected locations in parallel or round-robin.
    runtimeId string
    The id of the runtime to use for this check.
    script string
    A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file.
    setupSnippetId number
    An ID reference to a snippet to use in the setup phase of an API check.
    shouldFail boolean
    Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.
    sslCheck boolean
    Determines if the SSL certificate should be validated for expiry.

    Deprecated: The property ssl_check is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.

    sslCheckDomain string
    A valid fully qualified domain name (FQDN) to check its SSL certificate.
    tags string[]
    A list of tags for organizing and filtering checks.
    teardownSnippetId number
    An ID reference to a snippet to use in the teardown phase of an API check.
    useGlobalAlertSettings boolean
    When true, the account level alert settings will be used, not the alert setting defined on this check.
    activated bool
    Determines if the check is running or not. Possible values true, and false.
    frequency int
    The frequency in minutes to run the check. Possible values are 0, 1, 2, 5, 10, 15, 30, 60, 120, 180, 360, 720, and 1440.
    type str
    The type of the check. Possible values are API, BROWSER, and MULTI_STEP.
    alert_channel_subscriptions Sequence[CheckAlertChannelSubscriptionArgs]
    An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your check, we won't be able to alert you in case something goes wrong with it.
    alert_settings CheckAlertSettingsArgs
    degraded_response_time int
    The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 30000. (Default 15000).
    double_check bool
    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.

    Deprecated: The property double_check is deprecated and will be removed in a future version. To enable retries for failed check runs, use the retry_strategy property instead.

    environment_variable Sequence[CheckEnvironmentVariableArgs]
    Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden, add secret = true to create a secret variable. These are only relevant for browser checks. Use global environment variables whenever possible.
    environment_variables Mapping[str, str]
    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated: The property environment_variables is deprecated and will be removed in a future version. Consider using the new environment_variable list.

    frequency_offset int
    This property only valid for API high frequency checks. To create a hight frequency check, the property frequency must be 0 and frequency_offset could be 10, 20 or 30.
    group_id int
    The id of the check group this check is part of.
    group_order int
    The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.
    local_setup_script str
    A valid piece of Node.js code to run in the setup phase.
    local_teardown_script str
    A valid piece of Node.js code to run in the teardown phase.
    locations Sequence[str]
    An array of one or more data center locations where to run the this check. (Default ["us-east-1"])
    max_response_time int
    The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 30000. (Default 30000).
    muted bool
    Determines if any notifications will be sent out when a check fails/degrades/recovers.
    name str
    The name of the check.
    private_locations Sequence[str]
    An array of one or more private locations slugs.
    request CheckRequestArgs
    An API check might have one request config.
    retry_strategy CheckRetryStrategyArgs
    A strategy for retrying failed check runs.
    run_parallel bool
    Determines if the check should run in all selected locations in parallel or round-robin.
    runtime_id str
    The id of the runtime to use for this check.
    script str
    A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file.
    setup_snippet_id int
    An ID reference to a snippet to use in the setup phase of an API check.
    should_fail bool
    Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.
    ssl_check bool
    Determines if the SSL certificate should be validated for expiry.

    Deprecated: The property ssl_check is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.

    ssl_check_domain str
    A valid fully qualified domain name (FQDN) to check its SSL certificate.
    tags Sequence[str]
    A list of tags for organizing and filtering checks.
    teardown_snippet_id int
    An ID reference to a snippet to use in the teardown phase of an API check.
    use_global_alert_settings bool
    When true, the account level alert settings will be used, not the alert setting defined on this check.
    activated Boolean
    Determines if the check is running or not. Possible values true, and false.
    frequency Number
    The frequency in minutes to run the check. Possible values are 0, 1, 2, 5, 10, 15, 30, 60, 120, 180, 360, 720, and 1440.
    type String
    The type of the check. Possible values are API, BROWSER, and MULTI_STEP.
    alertChannelSubscriptions List<Property Map>
    An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your check, we won't be able to alert you in case something goes wrong with it.
    alertSettings Property Map
    degradedResponseTime Number
    The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 30000. (Default 15000).
    doubleCheck Boolean
    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.

    Deprecated: The property double_check is deprecated and will be removed in a future version. To enable retries for failed check runs, use the retry_strategy property instead.

    environmentVariable List<Property Map>
    Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden, add secret = true to create a secret variable. These are only relevant for browser checks. Use global environment variables whenever possible.
    environmentVariables Map<String>
    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated: The property environment_variables is deprecated and will be removed in a future version. Consider using the new environment_variable list.

    frequencyOffset Number
    This property only valid for API high frequency checks. To create a hight frequency check, the property frequency must be 0 and frequency_offset could be 10, 20 or 30.
    groupId Number
    The id of the check group this check is part of.
    groupOrder Number
    The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.
    localSetupScript String
    A valid piece of Node.js code to run in the setup phase.
    localTeardownScript String
    A valid piece of Node.js code to run in the teardown phase.
    locations List<String>
    An array of one or more data center locations where to run the this check. (Default ["us-east-1"])
    maxResponseTime Number
    The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 30000. (Default 30000).
    muted Boolean
    Determines if any notifications will be sent out when a check fails/degrades/recovers.
    name String
    The name of the check.
    privateLocations List<String>
    An array of one or more private locations slugs.
    request Property Map
    An API check might have one request config.
    retryStrategy Property Map
    A strategy for retrying failed check runs.
    runParallel Boolean
    Determines if the check should run in all selected locations in parallel or round-robin.
    runtimeId String
    The id of the runtime to use for this check.
    script String
    A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file.
    setupSnippetId Number
    An ID reference to a snippet to use in the setup phase of an API check.
    shouldFail Boolean
    Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.
    sslCheck Boolean
    Determines if the SSL certificate should be validated for expiry.

    Deprecated: The property ssl_check is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.

    sslCheckDomain String
    A valid fully qualified domain name (FQDN) to check its SSL certificate.
    tags List<String>
    A list of tags for organizing and filtering checks.
    teardownSnippetId Number
    An ID reference to a snippet to use in the teardown phase of an API check.
    useGlobalAlertSettings Boolean
    When true, the account level alert settings will be used, not the alert setting defined on this check.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Check resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Check Resource

    Get an existing Check 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?: CheckState, opts?: CustomResourceOptions): Check
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        activated: Optional[bool] = None,
        alert_channel_subscriptions: Optional[Sequence[CheckAlertChannelSubscriptionArgs]] = None,
        alert_settings: Optional[CheckAlertSettingsArgs] = None,
        degraded_response_time: Optional[int] = None,
        double_check: Optional[bool] = None,
        environment_variable: Optional[Sequence[CheckEnvironmentVariableArgs]] = None,
        environment_variables: Optional[Mapping[str, str]] = None,
        frequency: Optional[int] = None,
        frequency_offset: Optional[int] = None,
        group_id: Optional[int] = None,
        group_order: Optional[int] = None,
        local_setup_script: Optional[str] = None,
        local_teardown_script: Optional[str] = None,
        locations: Optional[Sequence[str]] = None,
        max_response_time: Optional[int] = None,
        muted: Optional[bool] = None,
        name: Optional[str] = None,
        private_locations: Optional[Sequence[str]] = None,
        request: Optional[CheckRequestArgs] = None,
        retry_strategy: Optional[CheckRetryStrategyArgs] = None,
        run_parallel: Optional[bool] = None,
        runtime_id: Optional[str] = None,
        script: Optional[str] = None,
        setup_snippet_id: Optional[int] = None,
        should_fail: Optional[bool] = None,
        ssl_check: Optional[bool] = None,
        ssl_check_domain: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        teardown_snippet_id: Optional[int] = None,
        type: Optional[str] = None,
        use_global_alert_settings: Optional[bool] = None) -> Check
    func GetCheck(ctx *Context, name string, id IDInput, state *CheckState, opts ...ResourceOption) (*Check, error)
    public static Check Get(string name, Input<string> id, CheckState? state, CustomResourceOptions? opts = null)
    public static Check get(String name, Output<String> id, CheckState state, CustomResourceOptions options)
    resources:  _:    type: checkly:Check    get:      id: ${id}
    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.
    The following state arguments are supported:
    Activated bool
    Determines if the check is running or not. Possible values true, and false.
    AlertChannelSubscriptions List<CheckAlertChannelSubscription>
    An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your check, we won't be able to alert you in case something goes wrong with it.
    AlertSettings CheckAlertSettings
    DegradedResponseTime int
    The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 30000. (Default 15000).
    DoubleCheck bool
    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.

    Deprecated: The property double_check is deprecated and will be removed in a future version. To enable retries for failed check runs, use the retry_strategy property instead.

    EnvironmentVariable List<CheckEnvironmentVariable>
    Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden, add secret = true to create a secret variable. These are only relevant for browser checks. Use global environment variables whenever possible.
    EnvironmentVariables Dictionary<string, string>
    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated: The property environment_variables is deprecated and will be removed in a future version. Consider using the new environment_variable list.

    Frequency int
    The frequency in minutes to run the check. Possible values are 0, 1, 2, 5, 10, 15, 30, 60, 120, 180, 360, 720, and 1440.
    FrequencyOffset int
    This property only valid for API high frequency checks. To create a hight frequency check, the property frequency must be 0 and frequency_offset could be 10, 20 or 30.
    GroupId int
    The id of the check group this check is part of.
    GroupOrder int
    The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.
    LocalSetupScript string
    A valid piece of Node.js code to run in the setup phase.
    LocalTeardownScript string
    A valid piece of Node.js code to run in the teardown phase.
    Locations List<string>
    An array of one or more data center locations where to run the this check. (Default ["us-east-1"])
    MaxResponseTime int
    The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 30000. (Default 30000).
    Muted bool
    Determines if any notifications will be sent out when a check fails/degrades/recovers.
    Name string
    The name of the check.
    PrivateLocations List<string>
    An array of one or more private locations slugs.
    Request CheckRequest
    An API check might have one request config.
    RetryStrategy CheckRetryStrategy
    A strategy for retrying failed check runs.
    RunParallel bool
    Determines if the check should run in all selected locations in parallel or round-robin.
    RuntimeId string
    The id of the runtime to use for this check.
    Script string
    A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file.
    SetupSnippetId int
    An ID reference to a snippet to use in the setup phase of an API check.
    ShouldFail bool
    Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.
    SslCheck bool
    Determines if the SSL certificate should be validated for expiry.

    Deprecated: The property ssl_check is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.

    SslCheckDomain string
    A valid fully qualified domain name (FQDN) to check its SSL certificate.
    Tags List<string>
    A list of tags for organizing and filtering checks.
    TeardownSnippetId int
    An ID reference to a snippet to use in the teardown phase of an API check.
    Type string
    The type of the check. Possible values are API, BROWSER, and MULTI_STEP.
    UseGlobalAlertSettings bool
    When true, the account level alert settings will be used, not the alert setting defined on this check.
    Activated bool
    Determines if the check is running or not. Possible values true, and false.
    AlertChannelSubscriptions []CheckAlertChannelSubscriptionArgs
    An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your check, we won't be able to alert you in case something goes wrong with it.
    AlertSettings CheckAlertSettingsArgs
    DegradedResponseTime int
    The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 30000. (Default 15000).
    DoubleCheck bool
    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.

    Deprecated: The property double_check is deprecated and will be removed in a future version. To enable retries for failed check runs, use the retry_strategy property instead.

    EnvironmentVariable []CheckEnvironmentVariableArgs
    Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden, add secret = true to create a secret variable. These are only relevant for browser checks. Use global environment variables whenever possible.
    EnvironmentVariables map[string]string
    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated: The property environment_variables is deprecated and will be removed in a future version. Consider using the new environment_variable list.

    Frequency int
    The frequency in minutes to run the check. Possible values are 0, 1, 2, 5, 10, 15, 30, 60, 120, 180, 360, 720, and 1440.
    FrequencyOffset int
    This property only valid for API high frequency checks. To create a hight frequency check, the property frequency must be 0 and frequency_offset could be 10, 20 or 30.
    GroupId int
    The id of the check group this check is part of.
    GroupOrder int
    The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.
    LocalSetupScript string
    A valid piece of Node.js code to run in the setup phase.
    LocalTeardownScript string
    A valid piece of Node.js code to run in the teardown phase.
    Locations []string
    An array of one or more data center locations where to run the this check. (Default ["us-east-1"])
    MaxResponseTime int
    The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 30000. (Default 30000).
    Muted bool
    Determines if any notifications will be sent out when a check fails/degrades/recovers.
    Name string
    The name of the check.
    PrivateLocations []string
    An array of one or more private locations slugs.
    Request CheckRequestArgs
    An API check might have one request config.
    RetryStrategy CheckRetryStrategyArgs
    A strategy for retrying failed check runs.
    RunParallel bool
    Determines if the check should run in all selected locations in parallel or round-robin.
    RuntimeId string
    The id of the runtime to use for this check.
    Script string
    A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file.
    SetupSnippetId int
    An ID reference to a snippet to use in the setup phase of an API check.
    ShouldFail bool
    Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.
    SslCheck bool
    Determines if the SSL certificate should be validated for expiry.

    Deprecated: The property ssl_check is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.

    SslCheckDomain string
    A valid fully qualified domain name (FQDN) to check its SSL certificate.
    Tags []string
    A list of tags for organizing and filtering checks.
    TeardownSnippetId int
    An ID reference to a snippet to use in the teardown phase of an API check.
    Type string
    The type of the check. Possible values are API, BROWSER, and MULTI_STEP.
    UseGlobalAlertSettings bool
    When true, the account level alert settings will be used, not the alert setting defined on this check.
    activated Boolean
    Determines if the check is running or not. Possible values true, and false.
    alertChannelSubscriptions List<CheckAlertChannelSubscription>
    An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your check, we won't be able to alert you in case something goes wrong with it.
    alertSettings CheckAlertSettings
    degradedResponseTime Integer
    The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 30000. (Default 15000).
    doubleCheck Boolean
    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.

    Deprecated: The property double_check is deprecated and will be removed in a future version. To enable retries for failed check runs, use the retry_strategy property instead.

    environmentVariable List<CheckEnvironmentVariable>
    Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden, add secret = true to create a secret variable. These are only relevant for browser checks. Use global environment variables whenever possible.
    environmentVariables Map<String,String>
    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated: The property environment_variables is deprecated and will be removed in a future version. Consider using the new environment_variable list.

    frequency Integer
    The frequency in minutes to run the check. Possible values are 0, 1, 2, 5, 10, 15, 30, 60, 120, 180, 360, 720, and 1440.
    frequencyOffset Integer
    This property only valid for API high frequency checks. To create a hight frequency check, the property frequency must be 0 and frequency_offset could be 10, 20 or 30.
    groupId Integer
    The id of the check group this check is part of.
    groupOrder Integer
    The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.
    localSetupScript String
    A valid piece of Node.js code to run in the setup phase.
    localTeardownScript String
    A valid piece of Node.js code to run in the teardown phase.
    locations List<String>
    An array of one or more data center locations where to run the this check. (Default ["us-east-1"])
    maxResponseTime Integer
    The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 30000. (Default 30000).
    muted Boolean
    Determines if any notifications will be sent out when a check fails/degrades/recovers.
    name String
    The name of the check.
    privateLocations List<String>
    An array of one or more private locations slugs.
    request CheckRequest
    An API check might have one request config.
    retryStrategy CheckRetryStrategy
    A strategy for retrying failed check runs.
    runParallel Boolean
    Determines if the check should run in all selected locations in parallel or round-robin.
    runtimeId String
    The id of the runtime to use for this check.
    script String
    A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file.
    setupSnippetId Integer
    An ID reference to a snippet to use in the setup phase of an API check.
    shouldFail Boolean
    Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.
    sslCheck Boolean
    Determines if the SSL certificate should be validated for expiry.

    Deprecated: The property ssl_check is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.

    sslCheckDomain String
    A valid fully qualified domain name (FQDN) to check its SSL certificate.
    tags List<String>
    A list of tags for organizing and filtering checks.
    teardownSnippetId Integer
    An ID reference to a snippet to use in the teardown phase of an API check.
    type String
    The type of the check. Possible values are API, BROWSER, and MULTI_STEP.
    useGlobalAlertSettings Boolean
    When true, the account level alert settings will be used, not the alert setting defined on this check.
    activated boolean
    Determines if the check is running or not. Possible values true, and false.
    alertChannelSubscriptions CheckAlertChannelSubscription[]
    An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your check, we won't be able to alert you in case something goes wrong with it.
    alertSettings CheckAlertSettings
    degradedResponseTime number
    The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 30000. (Default 15000).
    doubleCheck boolean
    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.

    Deprecated: The property double_check is deprecated and will be removed in a future version. To enable retries for failed check runs, use the retry_strategy property instead.

    environmentVariable CheckEnvironmentVariable[]
    Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden, add secret = true to create a secret variable. These are only relevant for browser checks. Use global environment variables whenever possible.
    environmentVariables {[key: string]: string}
    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated: The property environment_variables is deprecated and will be removed in a future version. Consider using the new environment_variable list.

    frequency number
    The frequency in minutes to run the check. Possible values are 0, 1, 2, 5, 10, 15, 30, 60, 120, 180, 360, 720, and 1440.
    frequencyOffset number
    This property only valid for API high frequency checks. To create a hight frequency check, the property frequency must be 0 and frequency_offset could be 10, 20 or 30.
    groupId number
    The id of the check group this check is part of.
    groupOrder number
    The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.
    localSetupScript string
    A valid piece of Node.js code to run in the setup phase.
    localTeardownScript string
    A valid piece of Node.js code to run in the teardown phase.
    locations string[]
    An array of one or more data center locations where to run the this check. (Default ["us-east-1"])
    maxResponseTime number
    The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 30000. (Default 30000).
    muted boolean
    Determines if any notifications will be sent out when a check fails/degrades/recovers.
    name string
    The name of the check.
    privateLocations string[]
    An array of one or more private locations slugs.
    request CheckRequest
    An API check might have one request config.
    retryStrategy CheckRetryStrategy
    A strategy for retrying failed check runs.
    runParallel boolean
    Determines if the check should run in all selected locations in parallel or round-robin.
    runtimeId string
    The id of the runtime to use for this check.
    script string
    A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file.
    setupSnippetId number
    An ID reference to a snippet to use in the setup phase of an API check.
    shouldFail boolean
    Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.
    sslCheck boolean
    Determines if the SSL certificate should be validated for expiry.

    Deprecated: The property ssl_check is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.

    sslCheckDomain string
    A valid fully qualified domain name (FQDN) to check its SSL certificate.
    tags string[]
    A list of tags for organizing and filtering checks.
    teardownSnippetId number
    An ID reference to a snippet to use in the teardown phase of an API check.
    type string
    The type of the check. Possible values are API, BROWSER, and MULTI_STEP.
    useGlobalAlertSettings boolean
    When true, the account level alert settings will be used, not the alert setting defined on this check.
    activated bool
    Determines if the check is running or not. Possible values true, and false.
    alert_channel_subscriptions Sequence[CheckAlertChannelSubscriptionArgs]
    An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your check, we won't be able to alert you in case something goes wrong with it.
    alert_settings CheckAlertSettingsArgs
    degraded_response_time int
    The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 30000. (Default 15000).
    double_check bool
    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.

    Deprecated: The property double_check is deprecated and will be removed in a future version. To enable retries for failed check runs, use the retry_strategy property instead.

    environment_variable Sequence[CheckEnvironmentVariableArgs]
    Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden, add secret = true to create a secret variable. These are only relevant for browser checks. Use global environment variables whenever possible.
    environment_variables Mapping[str, str]
    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated: The property environment_variables is deprecated and will be removed in a future version. Consider using the new environment_variable list.

    frequency int
    The frequency in minutes to run the check. Possible values are 0, 1, 2, 5, 10, 15, 30, 60, 120, 180, 360, 720, and 1440.
    frequency_offset int
    This property only valid for API high frequency checks. To create a hight frequency check, the property frequency must be 0 and frequency_offset could be 10, 20 or 30.
    group_id int
    The id of the check group this check is part of.
    group_order int
    The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.
    local_setup_script str
    A valid piece of Node.js code to run in the setup phase.
    local_teardown_script str
    A valid piece of Node.js code to run in the teardown phase.
    locations Sequence[str]
    An array of one or more data center locations where to run the this check. (Default ["us-east-1"])
    max_response_time int
    The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 30000. (Default 30000).
    muted bool
    Determines if any notifications will be sent out when a check fails/degrades/recovers.
    name str
    The name of the check.
    private_locations Sequence[str]
    An array of one or more private locations slugs.
    request CheckRequestArgs
    An API check might have one request config.
    retry_strategy CheckRetryStrategyArgs
    A strategy for retrying failed check runs.
    run_parallel bool
    Determines if the check should run in all selected locations in parallel or round-robin.
    runtime_id str
    The id of the runtime to use for this check.
    script str
    A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file.
    setup_snippet_id int
    An ID reference to a snippet to use in the setup phase of an API check.
    should_fail bool
    Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.
    ssl_check bool
    Determines if the SSL certificate should be validated for expiry.

    Deprecated: The property ssl_check is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.

    ssl_check_domain str
    A valid fully qualified domain name (FQDN) to check its SSL certificate.
    tags Sequence[str]
    A list of tags for organizing and filtering checks.
    teardown_snippet_id int
    An ID reference to a snippet to use in the teardown phase of an API check.
    type str
    The type of the check. Possible values are API, BROWSER, and MULTI_STEP.
    use_global_alert_settings bool
    When true, the account level alert settings will be used, not the alert setting defined on this check.
    activated Boolean
    Determines if the check is running or not. Possible values true, and false.
    alertChannelSubscriptions List<Property Map>
    An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your check, we won't be able to alert you in case something goes wrong with it.
    alertSettings Property Map
    degradedResponseTime Number
    The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 30000. (Default 15000).
    doubleCheck Boolean
    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.

    Deprecated: The property double_check is deprecated and will be removed in a future version. To enable retries for failed check runs, use the retry_strategy property instead.

    environmentVariable List<Property Map>
    Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden, add secret = true to create a secret variable. These are only relevant for browser checks. Use global environment variables whenever possible.
    environmentVariables Map<String>
    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated: The property environment_variables is deprecated and will be removed in a future version. Consider using the new environment_variable list.

    frequency Number
    The frequency in minutes to run the check. Possible values are 0, 1, 2, 5, 10, 15, 30, 60, 120, 180, 360, 720, and 1440.
    frequencyOffset Number
    This property only valid for API high frequency checks. To create a hight frequency check, the property frequency must be 0 and frequency_offset could be 10, 20 or 30.
    groupId Number
    The id of the check group this check is part of.
    groupOrder Number
    The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.
    localSetupScript String
    A valid piece of Node.js code to run in the setup phase.
    localTeardownScript String
    A valid piece of Node.js code to run in the teardown phase.
    locations List<String>
    An array of one or more data center locations where to run the this check. (Default ["us-east-1"])
    maxResponseTime Number
    The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 30000. (Default 30000).
    muted Boolean
    Determines if any notifications will be sent out when a check fails/degrades/recovers.
    name String
    The name of the check.
    privateLocations List<String>
    An array of one or more private locations slugs.
    request Property Map
    An API check might have one request config.
    retryStrategy Property Map
    A strategy for retrying failed check runs.
    runParallel Boolean
    Determines if the check should run in all selected locations in parallel or round-robin.
    runtimeId String
    The id of the runtime to use for this check.
    script String
    A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file.
    setupSnippetId Number
    An ID reference to a snippet to use in the setup phase of an API check.
    shouldFail Boolean
    Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.
    sslCheck Boolean
    Determines if the SSL certificate should be validated for expiry.

    Deprecated: The property ssl_check is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.

    sslCheckDomain String
    A valid fully qualified domain name (FQDN) to check its SSL certificate.
    tags List<String>
    A list of tags for organizing and filtering checks.
    teardownSnippetId Number
    An ID reference to a snippet to use in the teardown phase of an API check.
    type String
    The type of the check. Possible values are API, BROWSER, and MULTI_STEP.
    useGlobalAlertSettings Boolean
    When true, the account level alert settings will be used, not the alert setting defined on this check.

    Supporting Types

    CheckAlertChannelSubscription, CheckAlertChannelSubscriptionArgs

    activated Boolean
    channelId Integer
    activated boolean
    channelId number
    activated Boolean
    channelId Number

    CheckAlertSettings, CheckAlertSettingsArgs

    EscalationType string
    Determines what type of escalation to use. Possible values are RUN_BASED or TIME_BASED.
    ParallelRunFailureThresholds List<CheckAlertSettingsParallelRunFailureThreshold>
    Reminders List<CheckAlertSettingsReminder>
    RunBasedEscalations List<CheckAlertSettingsRunBasedEscalation>
    SslCertificates List<CheckAlertSettingsSslCertificate>

    Deprecated: This property is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.

    TimeBasedEscalations List<CheckAlertSettingsTimeBasedEscalation>
    EscalationType string
    Determines what type of escalation to use. Possible values are RUN_BASED or TIME_BASED.
    ParallelRunFailureThresholds []CheckAlertSettingsParallelRunFailureThreshold
    Reminders []CheckAlertSettingsReminder
    RunBasedEscalations []CheckAlertSettingsRunBasedEscalation
    SslCertificates []CheckAlertSettingsSslCertificate

    Deprecated: This property is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.

    TimeBasedEscalations []CheckAlertSettingsTimeBasedEscalation
    escalationType String
    Determines what type of escalation to use. Possible values are RUN_BASED or TIME_BASED.
    parallelRunFailureThresholds List<CheckAlertSettingsParallelRunFailureThreshold>
    reminders List<CheckAlertSettingsReminder>
    runBasedEscalations List<CheckAlertSettingsRunBasedEscalation>
    sslCertificates List<CheckAlertSettingsSslCertificate>

    Deprecated: This property is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.

    timeBasedEscalations List<CheckAlertSettingsTimeBasedEscalation>
    escalationType string
    Determines what type of escalation to use. Possible values are RUN_BASED or TIME_BASED.
    parallelRunFailureThresholds CheckAlertSettingsParallelRunFailureThreshold[]
    reminders CheckAlertSettingsReminder[]
    runBasedEscalations CheckAlertSettingsRunBasedEscalation[]
    sslCertificates CheckAlertSettingsSslCertificate[]

    Deprecated: This property is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.

    timeBasedEscalations CheckAlertSettingsTimeBasedEscalation[]
    escalationType String
    Determines what type of escalation to use. Possible values are RUN_BASED or TIME_BASED.
    parallelRunFailureThresholds List<Property Map>
    reminders List<Property Map>
    runBasedEscalations List<Property Map>
    sslCertificates List<Property Map>

    Deprecated: This property is deprecated and it's ignored by the Checkly Public API. It will be removed in a future version.

    timeBasedEscalations List<Property Map>

    CheckAlertSettingsParallelRunFailureThreshold, CheckAlertSettingsParallelRunFailureThresholdArgs

    Enabled bool
    Applicable only for checks scheduled in parallel in multiple locations.
    Percentage int
    Possible values are 10, 20, 30, 40, 50, 60, 70, 80, 100, and 100. (Default 10).
    Enabled bool
    Applicable only for checks scheduled in parallel in multiple locations.
    Percentage int
    Possible values are 10, 20, 30, 40, 50, 60, 70, 80, 100, and 100. (Default 10).
    enabled Boolean
    Applicable only for checks scheduled in parallel in multiple locations.
    percentage Integer
    Possible values are 10, 20, 30, 40, 50, 60, 70, 80, 100, and 100. (Default 10).
    enabled boolean
    Applicable only for checks scheduled in parallel in multiple locations.
    percentage number
    Possible values are 10, 20, 30, 40, 50, 60, 70, 80, 100, and 100. (Default 10).
    enabled bool
    Applicable only for checks scheduled in parallel in multiple locations.
    percentage int
    Possible values are 10, 20, 30, 40, 50, 60, 70, 80, 100, and 100. (Default 10).
    enabled Boolean
    Applicable only for checks scheduled in parallel in multiple locations.
    percentage Number
    Possible values are 10, 20, 30, 40, 50, 60, 70, 80, 100, and 100. (Default 10).

    CheckAlertSettingsReminder, CheckAlertSettingsReminderArgs

    Amount int
    How many reminders to send out after the initial alert notification. Possible values are 0, 1, 2, 3, 4, 5, and 100000
    Interval int
    Possible values are 5, 10, 15, and 30. (Default 5).
    Amount int
    How many reminders to send out after the initial alert notification. Possible values are 0, 1, 2, 3, 4, 5, and 100000
    Interval int
    Possible values are 5, 10, 15, and 30. (Default 5).
    amount Integer
    How many reminders to send out after the initial alert notification. Possible values are 0, 1, 2, 3, 4, 5, and 100000
    interval Integer
    Possible values are 5, 10, 15, and 30. (Default 5).
    amount number
    How many reminders to send out after the initial alert notification. Possible values are 0, 1, 2, 3, 4, 5, and 100000
    interval number
    Possible values are 5, 10, 15, and 30. (Default 5).
    amount int
    How many reminders to send out after the initial alert notification. Possible values are 0, 1, 2, 3, 4, 5, and 100000
    interval int
    Possible values are 5, 10, 15, and 30. (Default 5).
    amount Number
    How many reminders to send out after the initial alert notification. Possible values are 0, 1, 2, 3, 4, 5, and 100000
    interval Number
    Possible values are 5, 10, 15, and 30. (Default 5).

    CheckAlertSettingsRunBasedEscalation, CheckAlertSettingsRunBasedEscalationArgs

    FailedRunThreshold int
    After how many failed consecutive check runs an alert notification should be sent. Possible values are between 1 and 5. (Default 1).
    FailedRunThreshold int
    After how many failed consecutive check runs an alert notification should be sent. Possible values are between 1 and 5. (Default 1).
    failedRunThreshold Integer
    After how many failed consecutive check runs an alert notification should be sent. Possible values are between 1 and 5. (Default 1).
    failedRunThreshold number
    After how many failed consecutive check runs an alert notification should be sent. Possible values are between 1 and 5. (Default 1).
    failed_run_threshold int
    After how many failed consecutive check runs an alert notification should be sent. Possible values are between 1 and 5. (Default 1).
    failedRunThreshold Number
    After how many failed consecutive check runs an alert notification should be sent. Possible values are between 1 and 5. (Default 1).

    CheckAlertSettingsSslCertificate, CheckAlertSettingsSslCertificateArgs

    AlertThreshold int
    How long before SSL certificate expiry to send alerts. Possible values 3, 7, 14, 30. (Default 3).
    Enabled bool
    Determines if alert notifications should be sent for expiring SSL certificates. Possible values true, and false. (Default false).
    AlertThreshold int
    How long before SSL certificate expiry to send alerts. Possible values 3, 7, 14, 30. (Default 3).
    Enabled bool
    Determines if alert notifications should be sent for expiring SSL certificates. Possible values true, and false. (Default false).
    alertThreshold Integer
    How long before SSL certificate expiry to send alerts. Possible values 3, 7, 14, 30. (Default 3).
    enabled Boolean
    Determines if alert notifications should be sent for expiring SSL certificates. Possible values true, and false. (Default false).
    alertThreshold number
    How long before SSL certificate expiry to send alerts. Possible values 3, 7, 14, 30. (Default 3).
    enabled boolean
    Determines if alert notifications should be sent for expiring SSL certificates. Possible values true, and false. (Default false).
    alert_threshold int
    How long before SSL certificate expiry to send alerts. Possible values 3, 7, 14, 30. (Default 3).
    enabled bool
    Determines if alert notifications should be sent for expiring SSL certificates. Possible values true, and false. (Default false).
    alertThreshold Number
    How long before SSL certificate expiry to send alerts. Possible values 3, 7, 14, 30. (Default 3).
    enabled Boolean
    Determines if alert notifications should be sent for expiring SSL certificates. Possible values true, and false. (Default false).

    CheckAlertSettingsTimeBasedEscalation, CheckAlertSettingsTimeBasedEscalationArgs

    MinutesFailingThreshold int
    After how many minutes after a check starts failing an alert should be sent. Possible values are 5, 10, 15, and 30. (Default 5).
    MinutesFailingThreshold int
    After how many minutes after a check starts failing an alert should be sent. Possible values are 5, 10, 15, and 30. (Default 5).
    minutesFailingThreshold Integer
    After how many minutes after a check starts failing an alert should be sent. Possible values are 5, 10, 15, and 30. (Default 5).
    minutesFailingThreshold number
    After how many minutes after a check starts failing an alert should be sent. Possible values are 5, 10, 15, and 30. (Default 5).
    minutes_failing_threshold int
    After how many minutes after a check starts failing an alert should be sent. Possible values are 5, 10, 15, and 30. (Default 5).
    minutesFailingThreshold Number
    After how many minutes after a check starts failing an alert should be sent. Possible values are 5, 10, 15, and 30. (Default 5).

    CheckEnvironmentVariable, CheckEnvironmentVariableArgs

    Key string
    Value string
    Locked bool
    Secret bool
    Key string
    Value string
    Locked bool
    Secret bool
    key String
    value String
    locked Boolean
    secret Boolean
    key string
    value string
    locked boolean
    secret boolean
    key str
    value str
    locked bool
    secret bool
    key String
    value String
    locked Boolean
    secret Boolean

    CheckRequest, CheckRequestArgs

    Url string
    Assertions List<CheckRequestAssertion>
    A request can have multiple assertions.
    BasicAuth CheckRequestBasicAuth
    Set up HTTP basic authentication (username & password).
    Body string
    The body of the request.
    BodyType string
    The Content-Type header of the request. Possible values NONE, JSON, FORM, RAW, and GRAPHQL.
    FollowRedirects bool
    Headers Dictionary<string, string>
    IpFamily string
    IP Family to be used when executing the api check. The value can be either IPv4 or IPv6.
    Method string
    The HTTP method to use for this API check. Possible values are GET, POST, PUT, HEAD, DELETE, PATCH. (Default GET).
    QueryParameters Dictionary<string, string>
    SkipSsl bool
    Url string
    Assertions []CheckRequestAssertion
    A request can have multiple assertions.
    BasicAuth CheckRequestBasicAuth
    Set up HTTP basic authentication (username & password).
    Body string
    The body of the request.
    BodyType string
    The Content-Type header of the request. Possible values NONE, JSON, FORM, RAW, and GRAPHQL.
    FollowRedirects bool
    Headers map[string]string
    IpFamily string
    IP Family to be used when executing the api check. The value can be either IPv4 or IPv6.
    Method string
    The HTTP method to use for this API check. Possible values are GET, POST, PUT, HEAD, DELETE, PATCH. (Default GET).
    QueryParameters map[string]string
    SkipSsl bool
    url String
    assertions List<CheckRequestAssertion>
    A request can have multiple assertions.
    basicAuth CheckRequestBasicAuth
    Set up HTTP basic authentication (username & password).
    body String
    The body of the request.
    bodyType String
    The Content-Type header of the request. Possible values NONE, JSON, FORM, RAW, and GRAPHQL.
    followRedirects Boolean
    headers Map<String,String>
    ipFamily String
    IP Family to be used when executing the api check. The value can be either IPv4 or IPv6.
    method String
    The HTTP method to use for this API check. Possible values are GET, POST, PUT, HEAD, DELETE, PATCH. (Default GET).
    queryParameters Map<String,String>
    skipSsl Boolean
    url string
    assertions CheckRequestAssertion[]
    A request can have multiple assertions.
    basicAuth CheckRequestBasicAuth
    Set up HTTP basic authentication (username & password).
    body string
    The body of the request.
    bodyType string
    The Content-Type header of the request. Possible values NONE, JSON, FORM, RAW, and GRAPHQL.
    followRedirects boolean
    headers {[key: string]: string}
    ipFamily string
    IP Family to be used when executing the api check. The value can be either IPv4 or IPv6.
    method string
    The HTTP method to use for this API check. Possible values are GET, POST, PUT, HEAD, DELETE, PATCH. (Default GET).
    queryParameters {[key: string]: string}
    skipSsl boolean
    url str
    assertions Sequence[CheckRequestAssertion]
    A request can have multiple assertions.
    basic_auth CheckRequestBasicAuth
    Set up HTTP basic authentication (username & password).
    body str
    The body of the request.
    body_type str
    The Content-Type header of the request. Possible values NONE, JSON, FORM, RAW, and GRAPHQL.
    follow_redirects bool
    headers Mapping[str, str]
    ip_family str
    IP Family to be used when executing the api check. The value can be either IPv4 or IPv6.
    method str
    The HTTP method to use for this API check. Possible values are GET, POST, PUT, HEAD, DELETE, PATCH. (Default GET).
    query_parameters Mapping[str, str]
    skip_ssl bool
    url String
    assertions List<Property Map>
    A request can have multiple assertions.
    basicAuth Property Map
    Set up HTTP basic authentication (username & password).
    body String
    The body of the request.
    bodyType String
    The Content-Type header of the request. Possible values NONE, JSON, FORM, RAW, and GRAPHQL.
    followRedirects Boolean
    headers Map<String>
    ipFamily String
    IP Family to be used when executing the api check. The value can be either IPv4 or IPv6.
    method String
    The HTTP method to use for this API check. Possible values are GET, POST, PUT, HEAD, DELETE, PATCH. (Default GET).
    queryParameters Map<String>
    skipSsl Boolean

    CheckRequestAssertion, CheckRequestAssertionArgs

    Comparison string
    The type of comparison to be executed between expected and actual value of the assertion. Possible values EQUALS, NOT_EQUALS, HAS_KEY, NOT_HAS_KEY, HAS_VALUE, NOT_HAS_VALUE, IS_EMPTY, NOT_EMPTY, GREATER_THAN, LESS_THAN, CONTAINS, NOT_CONTAINS, IS_NULL, and NOT_NULL.
    Source string
    The source of the asserted value. Possible values STATUS_CODE, JSON_BODY, HEADERS, TEXT_BODY, and RESPONSE_TIME.
    Property string
    Target string
    Comparison string
    The type of comparison to be executed between expected and actual value of the assertion. Possible values EQUALS, NOT_EQUALS, HAS_KEY, NOT_HAS_KEY, HAS_VALUE, NOT_HAS_VALUE, IS_EMPTY, NOT_EMPTY, GREATER_THAN, LESS_THAN, CONTAINS, NOT_CONTAINS, IS_NULL, and NOT_NULL.
    Source string
    The source of the asserted value. Possible values STATUS_CODE, JSON_BODY, HEADERS, TEXT_BODY, and RESPONSE_TIME.
    Property string
    Target string
    comparison String
    The type of comparison to be executed between expected and actual value of the assertion. Possible values EQUALS, NOT_EQUALS, HAS_KEY, NOT_HAS_KEY, HAS_VALUE, NOT_HAS_VALUE, IS_EMPTY, NOT_EMPTY, GREATER_THAN, LESS_THAN, CONTAINS, NOT_CONTAINS, IS_NULL, and NOT_NULL.
    source String
    The source of the asserted value. Possible values STATUS_CODE, JSON_BODY, HEADERS, TEXT_BODY, and RESPONSE_TIME.
    property String
    target String
    comparison string
    The type of comparison to be executed between expected and actual value of the assertion. Possible values EQUALS, NOT_EQUALS, HAS_KEY, NOT_HAS_KEY, HAS_VALUE, NOT_HAS_VALUE, IS_EMPTY, NOT_EMPTY, GREATER_THAN, LESS_THAN, CONTAINS, NOT_CONTAINS, IS_NULL, and NOT_NULL.
    source string
    The source of the asserted value. Possible values STATUS_CODE, JSON_BODY, HEADERS, TEXT_BODY, and RESPONSE_TIME.
    property string
    target string
    comparison str
    The type of comparison to be executed between expected and actual value of the assertion. Possible values EQUALS, NOT_EQUALS, HAS_KEY, NOT_HAS_KEY, HAS_VALUE, NOT_HAS_VALUE, IS_EMPTY, NOT_EMPTY, GREATER_THAN, LESS_THAN, CONTAINS, NOT_CONTAINS, IS_NULL, and NOT_NULL.
    source str
    The source of the asserted value. Possible values STATUS_CODE, JSON_BODY, HEADERS, TEXT_BODY, and RESPONSE_TIME.
    property str
    target str
    comparison String
    The type of comparison to be executed between expected and actual value of the assertion. Possible values EQUALS, NOT_EQUALS, HAS_KEY, NOT_HAS_KEY, HAS_VALUE, NOT_HAS_VALUE, IS_EMPTY, NOT_EMPTY, GREATER_THAN, LESS_THAN, CONTAINS, NOT_CONTAINS, IS_NULL, and NOT_NULL.
    source String
    The source of the asserted value. Possible values STATUS_CODE, JSON_BODY, HEADERS, TEXT_BODY, and RESPONSE_TIME.
    property String
    target String

    CheckRequestBasicAuth, CheckRequestBasicAuthArgs

    Password string
    Username string
    Password string
    Username string
    password String
    username String
    password string
    username string
    password String
    username String

    CheckRetryStrategy, CheckRetryStrategyArgs

    Type string
    Determines which type of retry strategy to use. Possible values are FIXED, LINEAR, or EXPONENTIAL.
    BaseBackoffSeconds int
    The number of seconds to wait before the first retry attempt.
    MaxDurationSeconds int
    The total amount of time to continue retrying the check (maximum 600 seconds).
    MaxRetries int
    The maximum number of times to retry the check. Value must be between 1 and 10.
    SameRegion bool
    Whether retries should be run in the same region as the initial check run.
    Type string
    Determines which type of retry strategy to use. Possible values are FIXED, LINEAR, or EXPONENTIAL.
    BaseBackoffSeconds int
    The number of seconds to wait before the first retry attempt.
    MaxDurationSeconds int
    The total amount of time to continue retrying the check (maximum 600 seconds).
    MaxRetries int
    The maximum number of times to retry the check. Value must be between 1 and 10.
    SameRegion bool
    Whether retries should be run in the same region as the initial check run.
    type String
    Determines which type of retry strategy to use. Possible values are FIXED, LINEAR, or EXPONENTIAL.
    baseBackoffSeconds Integer
    The number of seconds to wait before the first retry attempt.
    maxDurationSeconds Integer
    The total amount of time to continue retrying the check (maximum 600 seconds).
    maxRetries Integer
    The maximum number of times to retry the check. Value must be between 1 and 10.
    sameRegion Boolean
    Whether retries should be run in the same region as the initial check run.
    type string
    Determines which type of retry strategy to use. Possible values are FIXED, LINEAR, or EXPONENTIAL.
    baseBackoffSeconds number
    The number of seconds to wait before the first retry attempt.
    maxDurationSeconds number
    The total amount of time to continue retrying the check (maximum 600 seconds).
    maxRetries number
    The maximum number of times to retry the check. Value must be between 1 and 10.
    sameRegion boolean
    Whether retries should be run in the same region as the initial check run.
    type str
    Determines which type of retry strategy to use. Possible values are FIXED, LINEAR, or EXPONENTIAL.
    base_backoff_seconds int
    The number of seconds to wait before the first retry attempt.
    max_duration_seconds int
    The total amount of time to continue retrying the check (maximum 600 seconds).
    max_retries int
    The maximum number of times to retry the check. Value must be between 1 and 10.
    same_region bool
    Whether retries should be run in the same region as the initial check run.
    type String
    Determines which type of retry strategy to use. Possible values are FIXED, LINEAR, or EXPONENTIAL.
    baseBackoffSeconds Number
    The number of seconds to wait before the first retry attempt.
    maxDurationSeconds Number
    The total amount of time to continue retrying the check (maximum 600 seconds).
    maxRetries Number
    The maximum number of times to retry the check. Value must be between 1 and 10.
    sameRegion Boolean
    Whether retries should be run in the same region as the initial check run.

    Package Details

    Repository
    checkly checkly/pulumi-checkly
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the checkly Terraform Provider.
    checkly logo
    Checkly v2.1.1 published on Tuesday, Mar 11, 2025 by Checkly
    checkly/pulumi-checkly