Checkly v2.7.0 published on Tuesday, Nov 4, 2025 by Checkly
checkly.Check
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,
name: Optional[str] = None,
script: 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,
max_response_time: Optional[int] = None,
muted: Optional[bool] = None,
alert_settings: Optional[CheckAlertSettingsArgs] = None,
double_check: Optional[bool] = None,
retry_strategy: Optional[CheckRetryStrategyArgs] = None,
private_locations: Optional[Sequence[str]] = None,
run_parallel: Optional[bool] = None,
runtime_id: Optional[str] = None,
request: Optional[CheckRequestArgs] = 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,
trigger_incident: Optional[CheckTriggerIncidentArgs] = 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)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,
Name = "string",
Script = "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",
},
MaxResponseTime = 0,
Muted = false,
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,
},
},
},
RetryStrategy = new Checkly.Inputs.CheckRetryStrategyArgs
{
Type = "string",
BaseBackoffSeconds = 0,
MaxDurationSeconds = 0,
MaxRetries = 0,
OnlyOn = new Checkly.Inputs.CheckRetryStrategyOnlyOnArgs
{
NetworkError = false,
},
SameRegion = false,
},
PrivateLocations = new[]
{
"string",
},
RunParallel = false,
RuntimeId = "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,
},
SetupSnippetId = 0,
ShouldFail = false,
SslCheckDomain = "string",
Tags = new[]
{
"string",
},
TeardownSnippetId = 0,
TriggerIncident = new Checkly.Inputs.CheckTriggerIncidentArgs
{
Description = "string",
Name = "string",
NotifySubscribers = false,
ServiceId = "string",
Severity = "string",
},
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),
Name: pulumi.String("string"),
Script: 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"),
},
MaxResponseTime: pulumi.Int(0),
Muted: pulumi.Bool(false),
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),
},
},
},
RetryStrategy: &checkly.CheckRetryStrategyArgs{
Type: pulumi.String("string"),
BaseBackoffSeconds: pulumi.Int(0),
MaxDurationSeconds: pulumi.Int(0),
MaxRetries: pulumi.Int(0),
OnlyOn: &checkly.CheckRetryStrategyOnlyOnArgs{
NetworkError: pulumi.Bool(false),
},
SameRegion: pulumi.Bool(false),
},
PrivateLocations: pulumi.StringArray{
pulumi.String("string"),
},
RunParallel: pulumi.Bool(false),
RuntimeId: 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),
},
SetupSnippetId: pulumi.Int(0),
ShouldFail: pulumi.Bool(false),
SslCheckDomain: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
TeardownSnippetId: pulumi.Int(0),
TriggerIncident: &checkly.CheckTriggerIncidentArgs{
Description: pulumi.String("string"),
Name: pulumi.String("string"),
NotifySubscribers: pulumi.Bool(false),
ServiceId: pulumi.String("string"),
Severity: pulumi.String("string"),
},
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)
.name("string")
.script("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")
.maxResponseTime(0)
.muted(false)
.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())
.retryStrategy(CheckRetryStrategyArgs.builder()
.type("string")
.baseBackoffSeconds(0)
.maxDurationSeconds(0)
.maxRetries(0)
.onlyOn(CheckRetryStrategyOnlyOnArgs.builder()
.networkError(false)
.build())
.sameRegion(false)
.build())
.privateLocations("string")
.runParallel(false)
.runtimeId("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())
.setupSnippetId(0)
.shouldFail(false)
.sslCheckDomain("string")
.tags("string")
.teardownSnippetId(0)
.triggerIncident(CheckTriggerIncidentArgs.builder()
.description("string")
.name("string")
.notifySubscribers(false)
.serviceId("string")
.severity("string")
.build())
.alertChannelSubscriptions(CheckAlertChannelSubscriptionArgs.builder()
.activated(false)
.channelId(0)
.build())
.useGlobalAlertSettings(false)
.build());
check_resource = checkly.Check("checkResource",
frequency=0,
type="string",
activated=False,
name="string",
script="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"],
max_response_time=0,
muted=False,
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,
}],
},
retry_strategy={
"type": "string",
"base_backoff_seconds": 0,
"max_duration_seconds": 0,
"max_retries": 0,
"only_on": {
"network_error": False,
},
"same_region": False,
},
private_locations=["string"],
run_parallel=False,
runtime_id="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,
},
setup_snippet_id=0,
should_fail=False,
ssl_check_domain="string",
tags=["string"],
teardown_snippet_id=0,
trigger_incident={
"description": "string",
"name": "string",
"notify_subscribers": False,
"service_id": "string",
"severity": "string",
},
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,
name: "string",
script: "string",
environmentVariable: [{
key: "string",
value: "string",
locked: false,
secret: false,
}],
degradedResponseTime: 0,
frequencyOffset: 0,
groupId: 0,
groupOrder: 0,
localSetupScript: "string",
localTeardownScript: "string",
locations: ["string"],
maxResponseTime: 0,
muted: false,
alertSettings: {
escalationType: "string",
parallelRunFailureThresholds: [{
enabled: false,
percentage: 0,
}],
reminders: [{
amount: 0,
interval: 0,
}],
runBasedEscalations: [{
failedRunThreshold: 0,
}],
timeBasedEscalations: [{
minutesFailingThreshold: 0,
}],
},
retryStrategy: {
type: "string",
baseBackoffSeconds: 0,
maxDurationSeconds: 0,
maxRetries: 0,
onlyOn: {
networkError: false,
},
sameRegion: false,
},
privateLocations: ["string"],
runParallel: false,
runtimeId: "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,
},
setupSnippetId: 0,
shouldFail: false,
sslCheckDomain: "string",
tags: ["string"],
teardownSnippetId: 0,
triggerIncident: {
description: "string",
name: "string",
notifySubscribers: false,
serviceId: "string",
severity: "string",
},
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
onlyOn:
networkError: false
sameRegion: false
type: string
runParallel: false
runtimeId: string
script: string
setupSnippetId: 0
shouldFail: false
sslCheckDomain: string
tags:
- string
teardownSnippetId: 0
triggerIncident:
description: string
name: string
notifySubscribers: false
serviceId: string
severity: string
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, andfalse. - 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, and1440. - Type string
- The type of the check. Possible values are
API,BROWSER, andMULTI_STEP. - Alert
Channel List<CheckSubscriptions Alert Channel Subscription> - 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 CheckAlert Settings - Determines the alert escalation policy for the check.
- Degraded
Response intTime - 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
truewill trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed. (Defaultfalse). - Environment
Variable List<CheckEnvironment Variable> - 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 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.
- Frequency
Offset int - This property only valid for API high frequency checks. To create a hight frequency check, the property
frequencymust be0andfrequency_offsetcould be10,20or30. - 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 stringScript - A valid piece of Node.js code to run in the setup phase.
- Local
Teardown stringScript - 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"])
- Max
Response intTime - 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.
- Private
Locations List<string> - An array of one or more private locations slugs.
- Request
Check
Request - An API check might have one request config.
- Retry
Strategy CheckRetry Strategy - A strategy for retrying failed check/monitor runs.
- Run
Parallel bool - Determines if the check should run in all selected locations in parallel or round-robin.
- Runtime
Id 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.
- Setup
Snippet intId - 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.
- Ssl
Check stringDomain - A valid fully qualified domain name (FQDN) to check its SSL certificate.
- List<string>
- A list of tags for organizing and filtering checks.
- Teardown
Snippet intId - An ID reference to a snippet to use in the teardown phase of an API check.
- Trigger
Incident CheckTrigger Incident - Create and resolve an incident based on the alert configuration. Useful for status page automation.
- Use
Global boolAlert Settings - 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, andfalse. - 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, and1440. - Type string
- The type of the check. Possible values are
API,BROWSER, andMULTI_STEP. - Alert
Channel []CheckSubscriptions Alert Channel Subscription Args - 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 CheckAlert Settings Args - Determines the alert escalation policy for the check.
- Degraded
Response intTime - 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
truewill trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed. (Defaultfalse). - Environment
Variable []CheckEnvironment Variable Args - 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 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.
- Frequency
Offset int - This property only valid for API high frequency checks. To create a hight frequency check, the property
frequencymust be0andfrequency_offsetcould be10,20or30. - 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 stringScript - A valid piece of Node.js code to run in the setup phase.
- Local
Teardown stringScript - 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"])
- Max
Response intTime - 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.
- Private
Locations []string - An array of one or more private locations slugs.
- Request
Check
Request Args - An API check might have one request config.
- Retry
Strategy CheckRetry Strategy Args - A strategy for retrying failed check/monitor runs.
- Run
Parallel bool - Determines if the check should run in all selected locations in parallel or round-robin.
- Runtime
Id 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.
- Setup
Snippet intId - 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.
- Ssl
Check stringDomain - A valid fully qualified domain name (FQDN) to check its SSL certificate.
- []string
- A list of tags for organizing and filtering checks.
- Teardown
Snippet intId - An ID reference to a snippet to use in the teardown phase of an API check.
- Trigger
Incident CheckTrigger Incident Args - Create and resolve an incident based on the alert configuration. Useful for status page automation.
- Use
Global boolAlert Settings - 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, andfalse. - 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, and1440. - type String
- The type of the check. Possible values are
API,BROWSER, andMULTI_STEP. - alert
Channel List<CheckSubscriptions Alert Channel Subscription> - 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 CheckAlert Settings - Determines the alert escalation policy for the check.
- degraded
Response IntegerTime - 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 Boolean - Setting this to
truewill trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed. (Defaultfalse). - environment
Variable List<CheckEnvironment Variable> - 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 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.
- frequency
Offset Integer - This property only valid for API high frequency checks. To create a hight frequency check, the property
frequencymust be0andfrequency_offsetcould be10,20or30. - group
Id Integer - The id of the check group this check is part of.
- group
Order 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.
- local
Setup StringScript - A valid piece of Node.js code to run in the setup phase.
- local
Teardown StringScript - 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"])
- max
Response IntegerTime - 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.
- private
Locations List<String> - An array of one or more private locations slugs.
- request
Check
Request - An API check might have one request config.
- retry
Strategy CheckRetry Strategy - A strategy for retrying failed check/monitor runs.
- run
Parallel Boolean - Determines if the check should run in all selected locations in parallel or round-robin.
- runtime
Id 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.
- setup
Snippet IntegerId - An ID reference to a snippet to use in the setup phase of an API check.
- should
Fail Boolean - Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.
- ssl
Check Boolean - Determines if the SSL certificate should be validated for expiry.
- ssl
Check StringDomain - A valid fully qualified domain name (FQDN) to check its SSL certificate.
- List<String>
- A list of tags for organizing and filtering checks.
- teardown
Snippet IntegerId - An ID reference to a snippet to use in the teardown phase of an API check.
- trigger
Incident CheckTrigger Incident - Create and resolve an incident based on the alert configuration. Useful for status page automation.
- use
Global BooleanAlert Settings - 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, andfalse. - 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, and1440. - type string
- The type of the check. Possible values are
API,BROWSER, andMULTI_STEP. - alert
Channel CheckSubscriptions Alert Channel Subscription[] - 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 CheckAlert Settings - Determines the alert escalation policy for the check.
- degraded
Response numberTime - 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 boolean - Setting this to
truewill trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed. (Defaultfalse). - environment
Variable CheckEnvironment Variable[] - 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 {[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.
- frequency
Offset number - This property only valid for API high frequency checks. To create a hight frequency check, the property
frequencymust be0andfrequency_offsetcould be10,20or30. - group
Id number - The id of the check group this check is part of.
- group
Order 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.
- local
Setup stringScript - A valid piece of Node.js code to run in the setup phase.
- local
Teardown stringScript - 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"])
- max
Response numberTime - 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.
- private
Locations string[] - An array of one or more private locations slugs.
- request
Check
Request - An API check might have one request config.
- retry
Strategy CheckRetry Strategy - A strategy for retrying failed check/monitor runs.
- run
Parallel boolean - Determines if the check should run in all selected locations in parallel or round-robin.
- runtime
Id 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.
- setup
Snippet numberId - An ID reference to a snippet to use in the setup phase of an API check.
- should
Fail boolean - Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.
- ssl
Check boolean - Determines if the SSL certificate should be validated for expiry.
- ssl
Check stringDomain - A valid fully qualified domain name (FQDN) to check its SSL certificate.
- string[]
- A list of tags for organizing and filtering checks.
- teardown
Snippet numberId - An ID reference to a snippet to use in the teardown phase of an API check.
- trigger
Incident CheckTrigger Incident - Create and resolve an incident based on the alert configuration. Useful for status page automation.
- use
Global booleanAlert Settings - 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, andfalse. - 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, and1440. - type str
- The type of the check. Possible values are
API,BROWSER, andMULTI_STEP. - alert_
channel_ Sequence[Checksubscriptions Alert Channel Subscription Args] - 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 CheckAlert Settings Args - Determines the alert escalation policy for the check.
- degraded_
response_ inttime - 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
truewill trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed. (Defaultfalse). - environment_
variable Sequence[CheckEnvironment Variable Args] - 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.
- frequency_
offset int - This property only valid for API high frequency checks. To create a hight frequency check, the property
frequencymust be0andfrequency_offsetcould be10,20or30. - 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_ strscript - A valid piece of Node.js code to run in the setup phase.
- local_
teardown_ strscript - 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_ inttime - 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
Check
Request Args - An API check might have one request config.
- retry_
strategy CheckRetry Strategy Args - A strategy for retrying failed check/monitor 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_ intid - 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.
- ssl_
check_ strdomain - A valid fully qualified domain name (FQDN) to check its SSL certificate.
- Sequence[str]
- A list of tags for organizing and filtering checks.
- teardown_
snippet_ intid - An ID reference to a snippet to use in the teardown phase of an API check.
- trigger_
incident CheckTrigger Incident Args - Create and resolve an incident based on the alert configuration. Useful for status page automation.
- use_
global_ boolalert_ settings - 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, andfalse. - 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, and1440. - type String
- The type of the check. Possible values are
API,BROWSER, andMULTI_STEP. - alert
Channel List<Property Map>Subscriptions - 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 Property Map - Determines the alert escalation policy for the check.
- degraded
Response NumberTime - 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 Boolean - Setting this to
truewill trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed. (Defaultfalse). - environment
Variable 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.
- environment
Variables 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.
- frequency
Offset Number - This property only valid for API high frequency checks. To create a hight frequency check, the property
frequencymust be0andfrequency_offsetcould be10,20or30. - group
Id Number - The id of the check group this check is part of.
- group
Order 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.
- local
Setup StringScript - A valid piece of Node.js code to run in the setup phase.
- local
Teardown StringScript - 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"])
- max
Response NumberTime - 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.
- private
Locations List<String> - An array of one or more private locations slugs.
- request Property Map
- An API check might have one request config.
- retry
Strategy Property Map - A strategy for retrying failed check/monitor runs.
- run
Parallel Boolean - Determines if the check should run in all selected locations in parallel or round-robin.
- runtime
Id 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.
- setup
Snippet NumberId - An ID reference to a snippet to use in the setup phase of an API check.
- should
Fail Boolean - Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.
- ssl
Check Boolean - Determines if the SSL certificate should be validated for expiry.
- ssl
Check StringDomain - A valid fully qualified domain name (FQDN) to check its SSL certificate.
- List<String>
- A list of tags for organizing and filtering checks.
- teardown
Snippet NumberId - An ID reference to a snippet to use in the teardown phase of an API check.
- trigger
Incident Property Map - Create and resolve an incident based on the alert configuration. Useful for status page automation.
- use
Global BooleanAlert Settings - 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,
trigger_incident: Optional[CheckTriggerIncidentArgs] = None,
type: Optional[str] = None,
use_global_alert_settings: Optional[bool] = None) -> Checkfunc 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.
- Activated bool
- Determines if the check is running or not. Possible values
true, andfalse. - Alert
Channel List<CheckSubscriptions Alert Channel Subscription> - 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 CheckAlert Settings - Determines the alert escalation policy for the check.
- Degraded
Response intTime - 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
truewill trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed. (Defaultfalse). - Environment
Variable List<CheckEnvironment Variable> - 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 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.
- 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, and1440. - Frequency
Offset int - This property only valid for API high frequency checks. To create a hight frequency check, the property
frequencymust be0andfrequency_offsetcould be10,20or30. - 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 stringScript - A valid piece of Node.js code to run in the setup phase.
- Local
Teardown stringScript - 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"])
- Max
Response intTime - 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.
- Private
Locations List<string> - An array of one or more private locations slugs.
- Request
Check
Request - An API check might have one request config.
- Retry
Strategy CheckRetry Strategy - A strategy for retrying failed check/monitor runs.
- Run
Parallel bool - Determines if the check should run in all selected locations in parallel or round-robin.
- Runtime
Id 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.
- Setup
Snippet intId - 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.
- Ssl
Check stringDomain - A valid fully qualified domain name (FQDN) to check its SSL certificate.
- List<string>
- A list of tags for organizing and filtering checks.
- Teardown
Snippet intId - An ID reference to a snippet to use in the teardown phase of an API check.
- Trigger
Incident CheckTrigger Incident - Create and resolve an incident based on the alert configuration. Useful for status page automation.
- Type string
- The type of the check. Possible values are
API,BROWSER, andMULTI_STEP. - Use
Global boolAlert Settings - 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, andfalse. - Alert
Channel []CheckSubscriptions Alert Channel Subscription Args - 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 CheckAlert Settings Args - Determines the alert escalation policy for the check.
- Degraded
Response intTime - 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
truewill trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed. (Defaultfalse). - Environment
Variable []CheckEnvironment Variable Args - 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 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.
- 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, and1440. - Frequency
Offset int - This property only valid for API high frequency checks. To create a hight frequency check, the property
frequencymust be0andfrequency_offsetcould be10,20or30. - 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 stringScript - A valid piece of Node.js code to run in the setup phase.
- Local
Teardown stringScript - 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"])
- Max
Response intTime - 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.
- Private
Locations []string - An array of one or more private locations slugs.
- Request
Check
Request Args - An API check might have one request config.
- Retry
Strategy CheckRetry Strategy Args - A strategy for retrying failed check/monitor runs.
- Run
Parallel bool - Determines if the check should run in all selected locations in parallel or round-robin.
- Runtime
Id 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.
- Setup
Snippet intId - 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.
- Ssl
Check stringDomain - A valid fully qualified domain name (FQDN) to check its SSL certificate.
- []string
- A list of tags for organizing and filtering checks.
- Teardown
Snippet intId - An ID reference to a snippet to use in the teardown phase of an API check.
- Trigger
Incident CheckTrigger Incident Args - Create and resolve an incident based on the alert configuration. Useful for status page automation.
- Type string
- The type of the check. Possible values are
API,BROWSER, andMULTI_STEP. - Use
Global boolAlert Settings - 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, andfalse. - alert
Channel List<CheckSubscriptions Alert Channel Subscription> - 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 CheckAlert Settings - Determines the alert escalation policy for the check.
- degraded
Response IntegerTime - 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 Boolean - Setting this to
truewill trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed. (Defaultfalse). - environment
Variable List<CheckEnvironment Variable> - 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 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.
- 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, and1440. - frequency
Offset Integer - This property only valid for API high frequency checks. To create a hight frequency check, the property
frequencymust be0andfrequency_offsetcould be10,20or30. - group
Id Integer - The id of the check group this check is part of.
- group
Order 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.
- local
Setup StringScript - A valid piece of Node.js code to run in the setup phase.
- local
Teardown StringScript - 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"])
- max
Response IntegerTime - 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.
- private
Locations List<String> - An array of one or more private locations slugs.
- request
Check
Request - An API check might have one request config.
- retry
Strategy CheckRetry Strategy - A strategy for retrying failed check/monitor runs.
- run
Parallel Boolean - Determines if the check should run in all selected locations in parallel or round-robin.
- runtime
Id 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.
- setup
Snippet IntegerId - An ID reference to a snippet to use in the setup phase of an API check.
- should
Fail Boolean - Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.
- ssl
Check Boolean - Determines if the SSL certificate should be validated for expiry.
- ssl
Check StringDomain - A valid fully qualified domain name (FQDN) to check its SSL certificate.
- List<String>
- A list of tags for organizing and filtering checks.
- teardown
Snippet IntegerId - An ID reference to a snippet to use in the teardown phase of an API check.
- trigger
Incident CheckTrigger Incident - Create and resolve an incident based on the alert configuration. Useful for status page automation.
- type String
- The type of the check. Possible values are
API,BROWSER, andMULTI_STEP. - use
Global BooleanAlert Settings - 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, andfalse. - alert
Channel CheckSubscriptions Alert Channel Subscription[] - 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 CheckAlert Settings - Determines the alert escalation policy for the check.
- degraded
Response numberTime - 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 boolean - Setting this to
truewill trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed. (Defaultfalse). - environment
Variable CheckEnvironment Variable[] - 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 {[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.
- 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, and1440. - frequency
Offset number - This property only valid for API high frequency checks. To create a hight frequency check, the property
frequencymust be0andfrequency_offsetcould be10,20or30. - group
Id number - The id of the check group this check is part of.
- group
Order 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.
- local
Setup stringScript - A valid piece of Node.js code to run in the setup phase.
- local
Teardown stringScript - 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"])
- max
Response numberTime - 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.
- private
Locations string[] - An array of one or more private locations slugs.
- request
Check
Request - An API check might have one request config.
- retry
Strategy CheckRetry Strategy - A strategy for retrying failed check/monitor runs.
- run
Parallel boolean - Determines if the check should run in all selected locations in parallel or round-robin.
- runtime
Id 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.
- setup
Snippet numberId - An ID reference to a snippet to use in the setup phase of an API check.
- should
Fail boolean - Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.
- ssl
Check boolean - Determines if the SSL certificate should be validated for expiry.
- ssl
Check stringDomain - A valid fully qualified domain name (FQDN) to check its SSL certificate.
- string[]
- A list of tags for organizing and filtering checks.
- teardown
Snippet numberId - An ID reference to a snippet to use in the teardown phase of an API check.
- trigger
Incident CheckTrigger Incident - Create and resolve an incident based on the alert configuration. Useful for status page automation.
- type string
- The type of the check. Possible values are
API,BROWSER, andMULTI_STEP. - use
Global booleanAlert Settings - 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, andfalse. - alert_
channel_ Sequence[Checksubscriptions Alert Channel Subscription Args] - 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 CheckAlert Settings Args - Determines the alert escalation policy for the check.
- degraded_
response_ inttime - 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
truewill trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed. (Defaultfalse). - environment_
variable Sequence[CheckEnvironment Variable Args] - 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.
- 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, and1440. - frequency_
offset int - This property only valid for API high frequency checks. To create a hight frequency check, the property
frequencymust be0andfrequency_offsetcould be10,20or30. - 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_ strscript - A valid piece of Node.js code to run in the setup phase.
- local_
teardown_ strscript - 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_ inttime - 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
Check
Request Args - An API check might have one request config.
- retry_
strategy CheckRetry Strategy Args - A strategy for retrying failed check/monitor 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_ intid - 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.
- ssl_
check_ strdomain - A valid fully qualified domain name (FQDN) to check its SSL certificate.
- Sequence[str]
- A list of tags for organizing and filtering checks.
- teardown_
snippet_ intid - An ID reference to a snippet to use in the teardown phase of an API check.
- trigger_
incident CheckTrigger Incident Args - Create and resolve an incident based on the alert configuration. Useful for status page automation.
- type str
- The type of the check. Possible values are
API,BROWSER, andMULTI_STEP. - use_
global_ boolalert_ settings - 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, andfalse. - alert
Channel List<Property Map>Subscriptions - 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 Property Map - Determines the alert escalation policy for the check.
- degraded
Response NumberTime - 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 Boolean - Setting this to
truewill trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed. (Defaultfalse). - environment
Variable 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.
- environment
Variables 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.
- 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, and1440. - frequency
Offset Number - This property only valid for API high frequency checks. To create a hight frequency check, the property
frequencymust be0andfrequency_offsetcould be10,20or30. - group
Id Number - The id of the check group this check is part of.
- group
Order 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.
- local
Setup StringScript - A valid piece of Node.js code to run in the setup phase.
- local
Teardown StringScript - 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"])
- max
Response NumberTime - 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.
- private
Locations List<String> - An array of one or more private locations slugs.
- request Property Map
- An API check might have one request config.
- retry
Strategy Property Map - A strategy for retrying failed check/monitor runs.
- run
Parallel Boolean - Determines if the check should run in all selected locations in parallel or round-robin.
- runtime
Id 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.
- setup
Snippet NumberId - An ID reference to a snippet to use in the setup phase of an API check.
- should
Fail Boolean - Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.
- ssl
Check Boolean - Determines if the SSL certificate should be validated for expiry.
- ssl
Check StringDomain - A valid fully qualified domain name (FQDN) to check its SSL certificate.
- List<String>
- A list of tags for organizing and filtering checks.
- teardown
Snippet NumberId - An ID reference to a snippet to use in the teardown phase of an API check.
- trigger
Incident Property Map - Create and resolve an incident based on the alert configuration. Useful for status page automation.
- type String
- The type of the check. Possible values are
API,BROWSER, andMULTI_STEP. - use
Global BooleanAlert Settings - When true, the account level alert settings will be used, not the alert setting defined on this check.
Supporting Types
CheckAlertChannelSubscription, CheckAlertChannelSubscriptionArgs
- activated bool
- channel_
id int
CheckAlertSettings, CheckAlertSettingsArgs
- Escalation
Type string - Determines the type of escalation to use. Possible values are
RUN_BASEDandTIME_BASED. (DefaultRUN_BASED). - Parallel
Run List<CheckFailure Thresholds Alert Settings Parallel Run Failure Threshold> - Configuration for parallel run failure threshold.
- Reminders
List<Check
Alert Settings Reminder> - Defines how often to send reminder notifications after initial alert.
- Run
Based List<CheckEscalations Alert Settings Run Based Escalation> - Configuration for run-based escalation.
- Ssl
Certificates List<CheckAlert Settings Ssl Certificate> - Time
Based List<CheckEscalations Alert Settings Time Based Escalation> - Configuration for time-based escalation.
- Escalation
Type string - Determines the type of escalation to use. Possible values are
RUN_BASEDandTIME_BASED. (DefaultRUN_BASED). - Parallel
Run []CheckFailure Thresholds Alert Settings Parallel Run Failure Threshold - Configuration for parallel run failure threshold.
- Reminders
[]Check
Alert Settings Reminder - Defines how often to send reminder notifications after initial alert.
- Run
Based []CheckEscalations Alert Settings Run Based Escalation - Configuration for run-based escalation.
- Ssl
Certificates []CheckAlert Settings Ssl Certificate - Time
Based []CheckEscalations Alert Settings Time Based Escalation - Configuration for time-based escalation.
- escalation
Type String - Determines the type of escalation to use. Possible values are
RUN_BASEDandTIME_BASED. (DefaultRUN_BASED). - parallel
Run List<CheckFailure Thresholds Alert Settings Parallel Run Failure Threshold> - Configuration for parallel run failure threshold.
- reminders
List<Check
Alert Settings Reminder> - Defines how often to send reminder notifications after initial alert.
- run
Based List<CheckEscalations Alert Settings Run Based Escalation> - Configuration for run-based escalation.
- ssl
Certificates List<CheckAlert Settings Ssl Certificate> - time
Based List<CheckEscalations Alert Settings Time Based Escalation> - Configuration for time-based escalation.
- escalation
Type string - Determines the type of escalation to use. Possible values are
RUN_BASEDandTIME_BASED. (DefaultRUN_BASED). - parallel
Run CheckFailure Thresholds Alert Settings Parallel Run Failure Threshold[] - Configuration for parallel run failure threshold.
- reminders
Check
Alert Settings Reminder[] - Defines how often to send reminder notifications after initial alert.
- run
Based CheckEscalations Alert Settings Run Based Escalation[] - Configuration for run-based escalation.
- ssl
Certificates CheckAlert Settings Ssl Certificate[] - time
Based CheckEscalations Alert Settings Time Based Escalation[] - Configuration for time-based escalation.
- escalation_
type str - Determines the type of escalation to use. Possible values are
RUN_BASEDandTIME_BASED. (DefaultRUN_BASED). - parallel_
run_ Sequence[Checkfailure_ thresholds Alert Settings Parallel Run Failure Threshold] - Configuration for parallel run failure threshold.
- reminders
Sequence[Check
Alert Settings Reminder] - Defines how often to send reminder notifications after initial alert.
- run_
based_ Sequence[Checkescalations Alert Settings Run Based Escalation] - Configuration for run-based escalation.
- ssl_
certificates Sequence[CheckAlert Settings Ssl Certificate] - time_
based_ Sequence[Checkescalations Alert Settings Time Based Escalation] - Configuration for time-based escalation.
- escalation
Type String - Determines the type of escalation to use. Possible values are
RUN_BASEDandTIME_BASED. (DefaultRUN_BASED). - parallel
Run List<Property Map>Failure Thresholds - Configuration for parallel run failure threshold.
- reminders List<Property Map>
- Defines how often to send reminder notifications after initial alert.
- run
Based List<Property Map>Escalations - Configuration for run-based escalation.
- ssl
Certificates List<Property Map> - time
Based List<Property Map>Escalations - Configuration for time-based escalation.
CheckAlertSettingsParallelRunFailureThreshold, CheckAlertSettingsParallelRunFailureThresholdArgs
- Enabled bool
- Whether parallel run failure threshold is enabled. Only applies if the check is scheduled for multiple locations in parallel. (Default
false). - Percentage int
- Percentage of runs that must fail to trigger alert. Possible values are
10,20,30,40,50,60,70,80,90, and100. (Default10).
- Enabled bool
- Whether parallel run failure threshold is enabled. Only applies if the check is scheduled for multiple locations in parallel. (Default
false). - Percentage int
- Percentage of runs that must fail to trigger alert. Possible values are
10,20,30,40,50,60,70,80,90, and100. (Default10).
- enabled Boolean
- Whether parallel run failure threshold is enabled. Only applies if the check is scheduled for multiple locations in parallel. (Default
false). - percentage Integer
- Percentage of runs that must fail to trigger alert. Possible values are
10,20,30,40,50,60,70,80,90, and100. (Default10).
- enabled boolean
- Whether parallel run failure threshold is enabled. Only applies if the check is scheduled for multiple locations in parallel. (Default
false). - percentage number
- Percentage of runs that must fail to trigger alert. Possible values are
10,20,30,40,50,60,70,80,90, and100. (Default10).
- enabled bool
- Whether parallel run failure threshold is enabled. Only applies if the check is scheduled for multiple locations in parallel. (Default
false). - percentage int
- Percentage of runs that must fail to trigger alert. Possible values are
10,20,30,40,50,60,70,80,90, and100. (Default10).
- enabled Boolean
- Whether parallel run failure threshold is enabled. Only applies if the check is scheduled for multiple locations in parallel. (Default
false). - percentage Number
- Percentage of runs that must fail to trigger alert. Possible values are
10,20,30,40,50,60,70,80,90, and100. (Default10).
CheckAlertSettingsReminder, CheckAlertSettingsReminderArgs
CheckAlertSettingsRunBasedEscalation, CheckAlertSettingsRunBasedEscalationArgs
- Failed
Run intThreshold - Send an alert notification after the given number of consecutive check runs have failed. Possible values are between
1and5. (Default1).
- Failed
Run intThreshold - Send an alert notification after the given number of consecutive check runs have failed. Possible values are between
1and5. (Default1).
- failed
Run IntegerThreshold - Send an alert notification after the given number of consecutive check runs have failed. Possible values are between
1and5. (Default1).
- failed
Run numberThreshold - Send an alert notification after the given number of consecutive check runs have failed. Possible values are between
1and5. (Default1).
- failed_
run_ intthreshold - Send an alert notification after the given number of consecutive check runs have failed. Possible values are between
1and5. (Default1).
- failed
Run NumberThreshold - Send an alert notification after the given number of consecutive check runs have failed. Possible values are between
1and5. (Default1).
CheckAlertSettingsSslCertificate, CheckAlertSettingsSslCertificateArgs
- Alert
Threshold int - No longer available.
- Enabled bool
- No longer available.
- Alert
Threshold int - No longer available.
- Enabled bool
- No longer available.
- alert
Threshold Integer - No longer available.
- enabled Boolean
- No longer available.
- alert
Threshold number - No longer available.
- enabled boolean
- No longer available.
- alert_
threshold int - No longer available.
- enabled bool
- No longer available.
- alert
Threshold Number - No longer available.
- enabled Boolean
- No longer available.
CheckAlertSettingsTimeBasedEscalation, CheckAlertSettingsTimeBasedEscalationArgs
- Minutes
Failing intThreshold - Send an alert notification after the check has been failing for the given amount of time (in minutes). Possible values are
5,10,15, and30. (Default5).
- Minutes
Failing intThreshold - Send an alert notification after the check has been failing for the given amount of time (in minutes). Possible values are
5,10,15, and30. (Default5).
- minutes
Failing IntegerThreshold - Send an alert notification after the check has been failing for the given amount of time (in minutes). Possible values are
5,10,15, and30. (Default5).
- minutes
Failing numberThreshold - Send an alert notification after the check has been failing for the given amount of time (in minutes). Possible values are
5,10,15, and30. (Default5).
- minutes_
failing_ intthreshold - Send an alert notification after the check has been failing for the given amount of time (in minutes). Possible values are
5,10,15, and30. (Default5).
- minutes
Failing NumberThreshold - Send an alert notification after the check has been failing for the given amount of time (in minutes). Possible values are
5,10,15, and30. (Default5).
CheckEnvironmentVariable, CheckEnvironmentVariableArgs
CheckRequest, CheckRequestArgs
- Url string
- Assertions
List<Check
Request Assertion> - A request can have multiple assertions.
- Basic
Auth CheckRequest Basic Auth - Set up HTTP basic authentication (username & password).
- Body string
- The body of the request.
- Body
Type string - The
Content-Typeheader of the request. Possible valuesNONE,JSON,FORM,RAW, andGRAPHQL. - Follow
Redirects bool - Headers Dictionary<string, string>
- Ip
Family 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. (DefaultGET). - Query
Parameters Dictionary<string, string> - Skip
Ssl bool
- Url string
- Assertions
[]Check
Request Assertion - A request can have multiple assertions.
- Basic
Auth CheckRequest Basic Auth - Set up HTTP basic authentication (username & password).
- Body string
- The body of the request.
- Body
Type string - The
Content-Typeheader of the request. Possible valuesNONE,JSON,FORM,RAW, andGRAPHQL. - Follow
Redirects bool - Headers map[string]string
- Ip
Family 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. (DefaultGET). - Query
Parameters map[string]string - Skip
Ssl bool
- url String
- assertions
List<Check
Request Assertion> - A request can have multiple assertions.
- basic
Auth CheckRequest Basic Auth - Set up HTTP basic authentication (username & password).
- body String
- The body of the request.
- body
Type String - The
Content-Typeheader of the request. Possible valuesNONE,JSON,FORM,RAW, andGRAPHQL. - follow
Redirects Boolean - headers Map<String,String>
- ip
Family 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. (DefaultGET). - query
Parameters Map<String,String> - skip
Ssl Boolean
- url string
- assertions
Check
Request Assertion[] - A request can have multiple assertions.
- basic
Auth CheckRequest Basic Auth - Set up HTTP basic authentication (username & password).
- body string
- The body of the request.
- body
Type string - The
Content-Typeheader of the request. Possible valuesNONE,JSON,FORM,RAW, andGRAPHQL. - follow
Redirects boolean - headers {[key: string]: string}
- ip
Family 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. (DefaultGET). - query
Parameters {[key: string]: string} - skip
Ssl boolean
- url str
- assertions
Sequence[Check
Request Assertion] - A request can have multiple assertions.
- basic_
auth CheckRequest Basic Auth - Set up HTTP basic authentication (username & password).
- body str
- The body of the request.
- body_
type str - The
Content-Typeheader of the request. Possible valuesNONE,JSON,FORM,RAW, andGRAPHQL. - 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. (DefaultGET). - query_
parameters Mapping[str, str] - skip_
ssl bool
- url String
- assertions List<Property Map>
- A request can have multiple assertions.
- basic
Auth Property Map - Set up HTTP basic authentication (username & password).
- body String
- The body of the request.
- body
Type String - The
Content-Typeheader of the request. Possible valuesNONE,JSON,FORM,RAW, andGRAPHQL. - follow
Redirects Boolean - headers Map<String>
- ip
Family 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. (DefaultGET). - query
Parameters Map<String> - skip
Ssl 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, andNOT_NULL. - Source string
- The source of the asserted value. Possible values
STATUS_CODE,JSON_BODY,HEADERS,TEXT_BODY, andRESPONSE_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, andNOT_NULL. - Source string
- The source of the asserted value. Possible values
STATUS_CODE,JSON_BODY,HEADERS,TEXT_BODY, andRESPONSE_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, andNOT_NULL. - source String
- The source of the asserted value. Possible values
STATUS_CODE,JSON_BODY,HEADERS,TEXT_BODY, andRESPONSE_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, andNOT_NULL. - source string
- The source of the asserted value. Possible values
STATUS_CODE,JSON_BODY,HEADERS,TEXT_BODY, andRESPONSE_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, andNOT_NULL. - source str
- The source of the asserted value. Possible values
STATUS_CODE,JSON_BODY,HEADERS,TEXT_BODY, andRESPONSE_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, andNOT_NULL. - source String
- The source of the asserted value. Possible values
STATUS_CODE,JSON_BODY,HEADERS,TEXT_BODY, andRESPONSE_TIME. - property String
- target String
CheckRequestBasicAuth, CheckRequestBasicAuthArgs
CheckRetryStrategy, CheckRetryStrategyArgs
- Type string
- Determines which type of retry strategy to use. Possible values are
FIXED,LINEAR,EXPONENTIAL,SINGLE_RETRY, andNO_RETRIES. - Base
Backoff intSeconds - The number of seconds to wait before the first retry attempt. (Default
60). - Max
Duration intSeconds - The total amount of time to continue retrying the check/monitor (maximum 600 seconds). Available when
typeisFIXED,LINEAR, orEXPONENTIAL. (Default600). - Max
Retries int - The maximum number of times to retry the check/monitor. Value must be between
1and10. Available whentypeisFIXED,LINEAR, orEXPONENTIAL. (Default2). - Only
On CheckRetry Strategy Only On - Apply the retry strategy only if the defined conditions match.
- Same
Region bool - Whether retries should be run in the same region as the initial check/monitor run. (Default
true).
- Type string
- Determines which type of retry strategy to use. Possible values are
FIXED,LINEAR,EXPONENTIAL,SINGLE_RETRY, andNO_RETRIES. - Base
Backoff intSeconds - The number of seconds to wait before the first retry attempt. (Default
60). - Max
Duration intSeconds - The total amount of time to continue retrying the check/monitor (maximum 600 seconds). Available when
typeisFIXED,LINEAR, orEXPONENTIAL. (Default600). - Max
Retries int - The maximum number of times to retry the check/monitor. Value must be between
1and10. Available whentypeisFIXED,LINEAR, orEXPONENTIAL. (Default2). - Only
On CheckRetry Strategy Only On - Apply the retry strategy only if the defined conditions match.
- Same
Region bool - Whether retries should be run in the same region as the initial check/monitor run. (Default
true).
- type String
- Determines which type of retry strategy to use. Possible values are
FIXED,LINEAR,EXPONENTIAL,SINGLE_RETRY, andNO_RETRIES. - base
Backoff IntegerSeconds - The number of seconds to wait before the first retry attempt. (Default
60). - max
Duration IntegerSeconds - The total amount of time to continue retrying the check/monitor (maximum 600 seconds). Available when
typeisFIXED,LINEAR, orEXPONENTIAL. (Default600). - max
Retries Integer - The maximum number of times to retry the check/monitor. Value must be between
1and10. Available whentypeisFIXED,LINEAR, orEXPONENTIAL. (Default2). - only
On CheckRetry Strategy Only On - Apply the retry strategy only if the defined conditions match.
- same
Region Boolean - Whether retries should be run in the same region as the initial check/monitor run. (Default
true).
- type string
- Determines which type of retry strategy to use. Possible values are
FIXED,LINEAR,EXPONENTIAL,SINGLE_RETRY, andNO_RETRIES. - base
Backoff numberSeconds - The number of seconds to wait before the first retry attempt. (Default
60). - max
Duration numberSeconds - The total amount of time to continue retrying the check/monitor (maximum 600 seconds). Available when
typeisFIXED,LINEAR, orEXPONENTIAL. (Default600). - max
Retries number - The maximum number of times to retry the check/monitor. Value must be between
1and10. Available whentypeisFIXED,LINEAR, orEXPONENTIAL. (Default2). - only
On CheckRetry Strategy Only On - Apply the retry strategy only if the defined conditions match.
- same
Region boolean - Whether retries should be run in the same region as the initial check/monitor run. (Default
true).
- type str
- Determines which type of retry strategy to use. Possible values are
FIXED,LINEAR,EXPONENTIAL,SINGLE_RETRY, andNO_RETRIES. - base_
backoff_ intseconds - The number of seconds to wait before the first retry attempt. (Default
60). - max_
duration_ intseconds - The total amount of time to continue retrying the check/monitor (maximum 600 seconds). Available when
typeisFIXED,LINEAR, orEXPONENTIAL. (Default600). - max_
retries int - The maximum number of times to retry the check/monitor. Value must be between
1and10. Available whentypeisFIXED,LINEAR, orEXPONENTIAL. (Default2). - only_
on CheckRetry Strategy Only On - Apply the retry strategy only if the defined conditions match.
- same_
region bool - Whether retries should be run in the same region as the initial check/monitor run. (Default
true).
- type String
- Determines which type of retry strategy to use. Possible values are
FIXED,LINEAR,EXPONENTIAL,SINGLE_RETRY, andNO_RETRIES. - base
Backoff NumberSeconds - The number of seconds to wait before the first retry attempt. (Default
60). - max
Duration NumberSeconds - The total amount of time to continue retrying the check/monitor (maximum 600 seconds). Available when
typeisFIXED,LINEAR, orEXPONENTIAL. (Default600). - max
Retries Number - The maximum number of times to retry the check/monitor. Value must be between
1and10. Available whentypeisFIXED,LINEAR, orEXPONENTIAL. (Default2). - only
On Property Map - Apply the retry strategy only if the defined conditions match.
- same
Region Boolean - Whether retries should be run in the same region as the initial check/monitor run. (Default
true).
CheckRetryStrategyOnlyOn, CheckRetryStrategyOnlyOnArgs
- Network
Error bool - When
true, retry only if the cause of the failure is a network error. (Defaultfalse).
- Network
Error bool - When
true, retry only if the cause of the failure is a network error. (Defaultfalse).
- network
Error Boolean - When
true, retry only if the cause of the failure is a network error. (Defaultfalse).
- network
Error boolean - When
true, retry only if the cause of the failure is a network error. (Defaultfalse).
- network_
error bool - When
true, retry only if the cause of the failure is a network error. (Defaultfalse).
- network
Error Boolean - When
true, retry only if the cause of the failure is a network error. (Defaultfalse).
CheckTriggerIncident, CheckTriggerIncidentArgs
- Description string
- A detailed description of the incident.
- Name string
- The name of the incident.
- Notify
Subscribers bool - Whether to notify subscribers when the incident is triggered.
- Service
Id string - The status page service that this incident will be associated with.
- Severity string
- The severity level of the incident. Possible values are
MINOR,MEDIUM,MAJOR, andCRITICAL.
- Description string
- A detailed description of the incident.
- Name string
- The name of the incident.
- Notify
Subscribers bool - Whether to notify subscribers when the incident is triggered.
- Service
Id string - The status page service that this incident will be associated with.
- Severity string
- The severity level of the incident. Possible values are
MINOR,MEDIUM,MAJOR, andCRITICAL.
- description String
- A detailed description of the incident.
- name String
- The name of the incident.
- notify
Subscribers Boolean - Whether to notify subscribers when the incident is triggered.
- service
Id String - The status page service that this incident will be associated with.
- severity String
- The severity level of the incident. Possible values are
MINOR,MEDIUM,MAJOR, andCRITICAL.
- description string
- A detailed description of the incident.
- name string
- The name of the incident.
- notify
Subscribers boolean - Whether to notify subscribers when the incident is triggered.
- service
Id string - The status page service that this incident will be associated with.
- severity string
- The severity level of the incident. Possible values are
MINOR,MEDIUM,MAJOR, andCRITICAL.
- description str
- A detailed description of the incident.
- name str
- The name of the incident.
- notify_
subscribers bool - Whether to notify subscribers when the incident is triggered.
- service_
id str - The status page service that this incident will be associated with.
- severity str
- The severity level of the incident. Possible values are
MINOR,MEDIUM,MAJOR, andCRITICAL.
- description String
- A detailed description of the incident.
- name String
- The name of the incident.
- notify
Subscribers Boolean - Whether to notify subscribers when the incident is triggered.
- service
Id String - The status page service that this incident will be associated with.
- severity String
- The severity level of the incident. Possible values are
MINOR,MEDIUM,MAJOR, andCRITICAL.
Package Details
- Repository
- checkly checkly/pulumi-checkly
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
checklyTerraform Provider.
