Docs Packages
  1. Packages
  2. Checkly
  3. API Docs
  4. Check
Checkly v1.1.4 published on Thursday, Mar 9, 2023 by checkly
checkly/pulumi-checkly

checkly.Check

Explore with Pulumi AI

checkly logo
Checkly v1.1.4 published on Thursday, Mar 9, 2023 by checkly
checkly/pulumi-checkly

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

    Create Check Resource

    new Check(name: string, args: CheckArgs, opts?: CustomResourceOptions);
    @overload
def Check(resource_name: 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_variables: Optional[Mapping[str, Any]] = 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,
          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,
          tags: Optional[Sequence[str]] = None,
          teardown_snippet_id: Optional[int] = None,
          type: Optional[str] = None,
          use_global_alert_settings: Optional[bool] = None)
@overload
def Check(resource_name: str,
          args: CheckArgs,
          opts: Optional[ResourceOptions] = None)
    func NewCheck(ctx *Context, name string, args CheckArgs, opts ...ResourceOption) (*Check, error)
    public Check(string name, CheckArgs args, CustomResourceOptions? opts = null)
    public Check(String name, CheckArgs args)
public Check(String name, CheckArgs args, CustomResourceOptions options)

    type: checkly:Check
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    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.

    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

    The Check resource accepts the following input properties:

    Activated bool

    Determines if the check is running or not. Possible values true, and false.

    Frequency int

    The frequency in minutes to run the check. Possible values are 0, 1, 2, 5, 10, 15, 30, 60, 120, 180, 360, 720, and 1440.

    Type string

    The type of the check. Possible values are API, and BROWSER.

    AlertChannelSubscriptions List<CheckAlertChannelSubscription>
    AlertSettings CheckAlertSettings
    DegradedResponseTime int

    The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 30000. (Default 15000).

    DoubleCheck bool

    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.

    EnvironmentVariables Dictionary<string, object>

    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated:

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

    FrequencyOffset int

    This property only valid for API high frequency checks. To create a hight frequency check, the property frequency must be 0 and frequency_offset could be 10, 20 or 30.

    GroupId int

    The id of the check group this check is part of.

    GroupOrder int

    The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.

    LocalSetupScript string

    A valid piece of Node.js code to run in the setup phase.

    LocalTeardownScript string

    A valid piece of Node.js code to run in the teardown phase.

    Locations List<string>

    An array of one or more data center locations where to run the this check. (Default ["us-east-1"])

    MaxResponseTime int

    The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 30000. (Default 30000).

    Muted bool

    Determines if any notifications will be sent out when a check fails/degrades/recovers.

    Name string

    The name of the check.

    PrivateLocations List<string>

    An array of one or more private locations slugs.

    Request CheckRequest

    An API check might have one request config.

    RuntimeId string

    The id of the runtime to use for this check.

    Script string

    A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file.

    SetupSnippetId int

    An ID reference to a snippet to use in the setup phase of an API check.

    ShouldFail bool

    Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.

    SslCheck bool

    Determines if the SSL certificate should be validated for expiry.

    Deprecated:

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

    Tags List<string>

    A list of tags for organizing and filtering checks.

    TeardownSnippetId int

    An ID reference to a snippet to use in the teardown phase of an API check.

    UseGlobalAlertSettings bool

    When true, the account level alert settings will be used, not the alert setting defined on this check.

    Activated bool

    Determines if the check is running or not. Possible values true, and false.

    Frequency int

    The frequency in minutes to run the check. Possible values are 0, 1, 2, 5, 10, 15, 30, 60, 120, 180, 360, 720, and 1440.

    Type string

    The type of the check. Possible values are API, and BROWSER.

    AlertChannelSubscriptions []CheckAlertChannelSubscriptionArgs
    AlertSettings CheckAlertSettingsArgs
    DegradedResponseTime int

    The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 30000. (Default 15000).

    DoubleCheck bool

    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.

    EnvironmentVariables map[string]interface{}

    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated:

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

    FrequencyOffset int

    This property only valid for API high frequency checks. To create a hight frequency check, the property frequency must be 0 and frequency_offset could be 10, 20 or 30.

    GroupId int

    The id of the check group this check is part of.

    GroupOrder int

    The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.

    LocalSetupScript string

    A valid piece of Node.js code to run in the setup phase.

    LocalTeardownScript string

    A valid piece of Node.js code to run in the teardown phase.

    Locations []string

    An array of one or more data center locations where to run the this check. (Default ["us-east-1"])

    MaxResponseTime int

    The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 30000. (Default 30000).

    Muted bool

    Determines if any notifications will be sent out when a check fails/degrades/recovers.

    Name string

    The name of the check.

    PrivateLocations []string

    An array of one or more private locations slugs.

    Request CheckRequestArgs

    An API check might have one request config.

    RuntimeId string

    The id of the runtime to use for this check.

    Script string

    A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file.

    SetupSnippetId int

    An ID reference to a snippet to use in the setup phase of an API check.

    ShouldFail bool

    Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.

    SslCheck bool

    Determines if the SSL certificate should be validated for expiry.

    Deprecated:

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

    Tags []string

    A list of tags for organizing and filtering checks.

    TeardownSnippetId int

    An ID reference to a snippet to use in the teardown phase of an API check.

    UseGlobalAlertSettings bool

    When true, the account level alert settings will be used, not the alert setting defined on this check.

    activated Boolean

    Determines if the check is running or not. Possible values true, and false.

    frequency Integer

    The frequency in minutes to run the check. Possible values are 0, 1, 2, 5, 10, 15, 30, 60, 120, 180, 360, 720, and 1440.

    type String

    The type of the check. Possible values are API, and BROWSER.

    alertChannelSubscriptions List<CheckAlertChannelSubscription>
    alertSettings CheckAlertSettings
    degradedResponseTime Integer

    The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 30000. (Default 15000).

    doubleCheck Boolean

    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.

    environmentVariables Map<String,Object>

    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated:

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

    frequencyOffset Integer

    This property only valid for API high frequency checks. To create a hight frequency check, the property frequency must be 0 and frequency_offset could be 10, 20 or 30.

    groupId Integer

    The id of the check group this check is part of.

    groupOrder Integer

    The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.

    localSetupScript String

    A valid piece of Node.js code to run in the setup phase.

    localTeardownScript String

    A valid piece of Node.js code to run in the teardown phase.

    locations List<String>

    An array of one or more data center locations where to run the this check. (Default ["us-east-1"])

    maxResponseTime Integer

    The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 30000. (Default 30000).

    muted Boolean

    Determines if any notifications will be sent out when a check fails/degrades/recovers.

    name String

    The name of the check.

    privateLocations List<String>

    An array of one or more private locations slugs.

    request CheckRequest

    An API check might have one request config.

    runtimeId String

    The id of the runtime to use for this check.

    script String

    A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file.

    setupSnippetId Integer

    An ID reference to a snippet to use in the setup phase of an API check.

    shouldFail Boolean

    Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.

    sslCheck Boolean

    Determines if the SSL certificate should be validated for expiry.

    Deprecated:

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

    tags List<String>

    A list of tags for organizing and filtering checks.

    teardownSnippetId Integer

    An ID reference to a snippet to use in the teardown phase of an API check.

    useGlobalAlertSettings Boolean

    When true, the account level alert settings will be used, not the alert setting defined on this check.

    activated boolean

    Determines if the check is running or not. Possible values true, and false.

    frequency number

    The frequency in minutes to run the check. Possible values are 0, 1, 2, 5, 10, 15, 30, 60, 120, 180, 360, 720, and 1440.

    type string

    The type of the check. Possible values are API, and BROWSER.

    alertChannelSubscriptions CheckAlertChannelSubscription[]
    alertSettings CheckAlertSettings
    degradedResponseTime number

    The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 30000. (Default 15000).

    doubleCheck boolean

    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.

    environmentVariables {[key: string]: any}

    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated:

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

    frequencyOffset number

    This property only valid for API high frequency checks. To create a hight frequency check, the property frequency must be 0 and frequency_offset could be 10, 20 or 30.

    groupId number

    The id of the check group this check is part of.

    groupOrder number

    The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.

    localSetupScript string

    A valid piece of Node.js code to run in the setup phase.

    localTeardownScript string

    A valid piece of Node.js code to run in the teardown phase.

    locations string[]

    An array of one or more data center locations where to run the this check. (Default ["us-east-1"])

    maxResponseTime number

    The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 30000. (Default 30000).

    muted boolean

    Determines if any notifications will be sent out when a check fails/degrades/recovers.

    name string

    The name of the check.

    privateLocations string[]

    An array of one or more private locations slugs.

    request CheckRequest

    An API check might have one request config.

    runtimeId string

    The id of the runtime to use for this check.

    script string

    A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file.

    setupSnippetId number

    An ID reference to a snippet to use in the setup phase of an API check.

    shouldFail boolean

    Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.

    sslCheck boolean

    Determines if the SSL certificate should be validated for expiry.

    Deprecated:

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

    tags string[]

    A list of tags for organizing and filtering checks.

    teardownSnippetId number

    An ID reference to a snippet to use in the teardown phase of an API check.

    useGlobalAlertSettings boolean

    When true, the account level alert settings will be used, not the alert setting defined on this check.

    activated bool

    Determines if the check is running or not. Possible values true, and false.

    frequency int

    The frequency in minutes to run the check. Possible values are 0, 1, 2, 5, 10, 15, 30, 60, 120, 180, 360, 720, and 1440.

    type str

    The type of the check. Possible values are API, and BROWSER.

    alert_channel_subscriptions Sequence[CheckAlertChannelSubscriptionArgs]
    alert_settings CheckAlertSettingsArgs
    degraded_response_time int

    The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 30000. (Default 15000).

    double_check bool

    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.

    environment_variables Mapping[str, Any]

    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated:

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

    frequency_offset int

    This property only valid for API high frequency checks. To create a hight frequency check, the property frequency must be 0 and frequency_offset could be 10, 20 or 30.

    group_id int

    The id of the check group this check is part of.

    group_order int

    The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.

    local_setup_script str

    A valid piece of Node.js code to run in the setup phase.

    local_teardown_script str

    A valid piece of Node.js code to run in the teardown phase.

    locations Sequence[str]

    An array of one or more data center locations where to run the this check. (Default ["us-east-1"])

    max_response_time int

    The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 30000. (Default 30000).

    muted bool

    Determines if any notifications will be sent out when a check fails/degrades/recovers.

    name str

    The name of the check.

    private_locations Sequence[str]

    An array of one or more private locations slugs.

    request CheckRequestArgs

    An API check might have one request config.

    runtime_id str

    The id of the runtime to use for this check.

    script str

    A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file.

    setup_snippet_id int

    An ID reference to a snippet to use in the setup phase of an API check.

    should_fail bool

    Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.

    ssl_check bool

    Determines if the SSL certificate should be validated for expiry.

    Deprecated:

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

    tags Sequence[str]

    A list of tags for organizing and filtering checks.

    teardown_snippet_id int

    An ID reference to a snippet to use in the teardown phase of an API check.

    use_global_alert_settings bool

    When true, the account level alert settings will be used, not the alert setting defined on this check.

    activated Boolean

    Determines if the check is running or not. Possible values true, and false.

    frequency Number

    The frequency in minutes to run the check. Possible values are 0, 1, 2, 5, 10, 15, 30, 60, 120, 180, 360, 720, and 1440.

    type String

    The type of the check. Possible values are API, and BROWSER.

    alertChannelSubscriptions List<Property Map>
    alertSettings Property Map
    degradedResponseTime Number

    The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 30000. (Default 15000).

    doubleCheck Boolean

    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.

    environmentVariables Map<Any>

    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated:

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

    frequencyOffset Number

    This property only valid for API high frequency checks. To create a hight frequency check, the property frequency must be 0 and frequency_offset could be 10, 20 or 30.

    groupId Number

    The id of the check group this check is part of.

    groupOrder Number

    The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.

    localSetupScript String

    A valid piece of Node.js code to run in the setup phase.

    localTeardownScript String

    A valid piece of Node.js code to run in the teardown phase.

    locations List<String>

    An array of one or more data center locations where to run the this check. (Default ["us-east-1"])

    maxResponseTime Number

    The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 30000. (Default 30000).

    muted Boolean

    Determines if any notifications will be sent out when a check fails/degrades/recovers.

    name String

    The name of the check.

    privateLocations List<String>

    An array of one or more private locations slugs.

    request Property Map

    An API check might have one request config.

    runtimeId String

    The id of the runtime to use for this check.

    script String

    A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file.

    setupSnippetId Number

    An ID reference to a snippet to use in the setup phase of an API check.

    shouldFail Boolean

    Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.

    sslCheck Boolean

    Determines if the SSL certificate should be validated for expiry.

    Deprecated:

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

    tags List<String>

    A list of tags for organizing and filtering checks.

    teardownSnippetId Number

    An ID reference to a snippet to use in the teardown phase of an API check.

    useGlobalAlertSettings Boolean

    When true, the account level alert settings will be used, not the alert setting defined on this check.

    Outputs

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

    Id string

    The provider-assigned unique ID for this managed resource.

    Id string

    The provider-assigned unique ID for this managed resource.

    id String

    The provider-assigned unique ID for this managed resource.

    id string

    The provider-assigned unique ID for this managed resource.

    id str

    The provider-assigned unique ID for this managed resource.

    id String

    The provider-assigned unique ID for this managed resource.

    Look up Existing Check Resource

    Get an existing Check resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: CheckState, opts?: CustomResourceOptions): Check
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        activated: Optional[bool] = None,
        alert_channel_subscriptions: Optional[Sequence[CheckAlertChannelSubscriptionArgs]] = None,
        alert_settings: Optional[CheckAlertSettingsArgs] = None,
        degraded_response_time: Optional[int] = None,
        double_check: Optional[bool] = None,
        environment_variables: Optional[Mapping[str, Any]] = 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,
        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,
        tags: Optional[Sequence[str]] = None,
        teardown_snippet_id: Optional[int] = None,
        type: Optional[str] = None,
        use_global_alert_settings: Optional[bool] = None) -> Check
    func GetCheck(ctx *Context, name string, id IDInput, state *CheckState, opts ...ResourceOption) (*Check, error)
    public static Check Get(string name, Input<string> id, CheckState? state, CustomResourceOptions? opts = null)
    public static Check get(String name, Output<String> id, CheckState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Activated bool

    Determines if the check is running or not. Possible values true, and false.

    AlertChannelSubscriptions List<CheckAlertChannelSubscription>
    AlertSettings CheckAlertSettings
    DegradedResponseTime int

    The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 30000. (Default 15000).

    DoubleCheck bool

    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.

    EnvironmentVariables Dictionary<string, object>

    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated:

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

    Frequency int

    The frequency in minutes to run the check. Possible values are 0, 1, 2, 5, 10, 15, 30, 60, 120, 180, 360, 720, and 1440.

    FrequencyOffset int

    This property only valid for API high frequency checks. To create a hight frequency check, the property frequency must be 0 and frequency_offset could be 10, 20 or 30.

    GroupId int

    The id of the check group this check is part of.

    GroupOrder int

    The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.

    LocalSetupScript string

    A valid piece of Node.js code to run in the setup phase.

    LocalTeardownScript string

    A valid piece of Node.js code to run in the teardown phase.

    Locations List<string>

    An array of one or more data center locations where to run the this check. (Default ["us-east-1"])

    MaxResponseTime int

    The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 30000. (Default 30000).

    Muted bool

    Determines if any notifications will be sent out when a check fails/degrades/recovers.

    Name string

    The name of the check.

    PrivateLocations List<string>

    An array of one or more private locations slugs.

    Request CheckRequest

    An API check might have one request config.

    RuntimeId string

    The id of the runtime to use for this check.

    Script string

    A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file.

    SetupSnippetId int

    An ID reference to a snippet to use in the setup phase of an API check.

    ShouldFail bool

    Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.

    SslCheck bool

    Determines if the SSL certificate should be validated for expiry.

    Deprecated:

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

    Tags List<string>

    A list of tags for organizing and filtering checks.

    TeardownSnippetId int

    An ID reference to a snippet to use in the teardown phase of an API check.

    Type string

    The type of the check. Possible values are API, and BROWSER.

    UseGlobalAlertSettings bool

    When true, the account level alert settings will be used, not the alert setting defined on this check.

    Activated bool

    Determines if the check is running or not. Possible values true, and false.

    AlertChannelSubscriptions []CheckAlertChannelSubscriptionArgs
    AlertSettings CheckAlertSettingsArgs
    DegradedResponseTime int

    The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 30000. (Default 15000).

    DoubleCheck bool

    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.

    EnvironmentVariables map[string]interface{}

    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated:

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

    Frequency int

    The frequency in minutes to run the check. Possible values are 0, 1, 2, 5, 10, 15, 30, 60, 120, 180, 360, 720, and 1440.

    FrequencyOffset int

    This property only valid for API high frequency checks. To create a hight frequency check, the property frequency must be 0 and frequency_offset could be 10, 20 or 30.

    GroupId int

    The id of the check group this check is part of.

    GroupOrder int

    The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.

    LocalSetupScript string

    A valid piece of Node.js code to run in the setup phase.

    LocalTeardownScript string

    A valid piece of Node.js code to run in the teardown phase.

    Locations []string

    An array of one or more data center locations where to run the this check. (Default ["us-east-1"])

    MaxResponseTime int

    The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 30000. (Default 30000).

    Muted bool

    Determines if any notifications will be sent out when a check fails/degrades/recovers.

    Name string

    The name of the check.

    PrivateLocations []string

    An array of one or more private locations slugs.

    Request CheckRequestArgs

    An API check might have one request config.

    RuntimeId string

    The id of the runtime to use for this check.

    Script string

    A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file.

    SetupSnippetId int

    An ID reference to a snippet to use in the setup phase of an API check.

    ShouldFail bool

    Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.

    SslCheck bool

    Determines if the SSL certificate should be validated for expiry.

    Deprecated:

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

    Tags []string

    A list of tags for organizing and filtering checks.

    TeardownSnippetId int

    An ID reference to a snippet to use in the teardown phase of an API check.

    Type string

    The type of the check. Possible values are API, and BROWSER.

    UseGlobalAlertSettings bool

    When true, the account level alert settings will be used, not the alert setting defined on this check.

    activated Boolean

    Determines if the check is running or not. Possible values true, and false.

    alertChannelSubscriptions List<CheckAlertChannelSubscription>
    alertSettings CheckAlertSettings
    degradedResponseTime Integer

    The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 30000. (Default 15000).

    doubleCheck Boolean

    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.

    environmentVariables Map<String,Object>

    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated:

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

    frequency Integer

    The frequency in minutes to run the check. Possible values are 0, 1, 2, 5, 10, 15, 30, 60, 120, 180, 360, 720, and 1440.

    frequencyOffset Integer

    This property only valid for API high frequency checks. To create a hight frequency check, the property frequency must be 0 and frequency_offset could be 10, 20 or 30.

    groupId Integer

    The id of the check group this check is part of.

    groupOrder Integer

    The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.

    localSetupScript String

    A valid piece of Node.js code to run in the setup phase.

    localTeardownScript String

    A valid piece of Node.js code to run in the teardown phase.

    locations List<String>

    An array of one or more data center locations where to run the this check. (Default ["us-east-1"])

    maxResponseTime Integer

    The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 30000. (Default 30000).

    muted Boolean

    Determines if any notifications will be sent out when a check fails/degrades/recovers.

    name String

    The name of the check.

    privateLocations List<String>

    An array of one or more private locations slugs.

    request CheckRequest

    An API check might have one request config.

    runtimeId String

    The id of the runtime to use for this check.

    script String

    A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file.

    setupSnippetId Integer

    An ID reference to a snippet to use in the setup phase of an API check.

    shouldFail Boolean

    Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.

    sslCheck Boolean

    Determines if the SSL certificate should be validated for expiry.

    Deprecated:

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

    tags List<String>

    A list of tags for organizing and filtering checks.

    teardownSnippetId Integer

    An ID reference to a snippet to use in the teardown phase of an API check.

    type String

    The type of the check. Possible values are API, and BROWSER.

    useGlobalAlertSettings Boolean

    When true, the account level alert settings will be used, not the alert setting defined on this check.

    activated boolean

    Determines if the check is running or not. Possible values true, and false.

    alertChannelSubscriptions CheckAlertChannelSubscription[]
    alertSettings CheckAlertSettings
    degradedResponseTime number

    The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 30000. (Default 15000).

    doubleCheck boolean

    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.

    environmentVariables {[key: string]: any}

    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated:

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

    frequency number

    The frequency in minutes to run the check. Possible values are 0, 1, 2, 5, 10, 15, 30, 60, 120, 180, 360, 720, and 1440.

    frequencyOffset number

    This property only valid for API high frequency checks. To create a hight frequency check, the property frequency must be 0 and frequency_offset could be 10, 20 or 30.

    groupId number

    The id of the check group this check is part of.

    groupOrder number

    The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.

    localSetupScript string

    A valid piece of Node.js code to run in the setup phase.

    localTeardownScript string

    A valid piece of Node.js code to run in the teardown phase.

    locations string[]

    An array of one or more data center locations where to run the this check. (Default ["us-east-1"])

    maxResponseTime number

    The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 30000. (Default 30000).

    muted boolean

    Determines if any notifications will be sent out when a check fails/degrades/recovers.

    name string

    The name of the check.

    privateLocations string[]

    An array of one or more private locations slugs.

    request CheckRequest

    An API check might have one request config.

    runtimeId string

    The id of the runtime to use for this check.

    script string

    A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file.

    setupSnippetId number

    An ID reference to a snippet to use in the setup phase of an API check.

    shouldFail boolean

    Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.

    sslCheck boolean

    Determines if the SSL certificate should be validated for expiry.

    Deprecated:

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

    tags string[]

    A list of tags for organizing and filtering checks.

    teardownSnippetId number

    An ID reference to a snippet to use in the teardown phase of an API check.

    type string

    The type of the check. Possible values are API, and BROWSER.

    useGlobalAlertSettings boolean

    When true, the account level alert settings will be used, not the alert setting defined on this check.

    activated bool

    Determines if the check is running or not. Possible values true, and false.

    alert_channel_subscriptions Sequence[CheckAlertChannelSubscriptionArgs]
    alert_settings CheckAlertSettingsArgs
    degraded_response_time int

    The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 30000. (Default 15000).

    double_check bool

    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.

    environment_variables Mapping[str, Any]

    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated:

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

    frequency int

    The frequency in minutes to run the check. Possible values are 0, 1, 2, 5, 10, 15, 30, 60, 120, 180, 360, 720, and 1440.

    frequency_offset int

    This property only valid for API high frequency checks. To create a hight frequency check, the property frequency must be 0 and frequency_offset could be 10, 20 or 30.

    group_id int

    The id of the check group this check is part of.

    group_order int

    The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.

    local_setup_script str

    A valid piece of Node.js code to run in the setup phase.

    local_teardown_script str

    A valid piece of Node.js code to run in the teardown phase.

    locations Sequence[str]

    An array of one or more data center locations where to run the this check. (Default ["us-east-1"])

    max_response_time int

    The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 30000. (Default 30000).

    muted bool

    Determines if any notifications will be sent out when a check fails/degrades/recovers.

    name str

    The name of the check.

    private_locations Sequence[str]

    An array of one or more private locations slugs.

    request CheckRequestArgs

    An API check might have one request config.

    runtime_id str

    The id of the runtime to use for this check.

    script str

    A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file.

    setup_snippet_id int

    An ID reference to a snippet to use in the setup phase of an API check.

    should_fail bool

    Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.

    ssl_check bool

    Determines if the SSL certificate should be validated for expiry.

    Deprecated:

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

    tags Sequence[str]

    A list of tags for organizing and filtering checks.

    teardown_snippet_id int

    An ID reference to a snippet to use in the teardown phase of an API check.

    type str

    The type of the check. Possible values are API, and BROWSER.

    use_global_alert_settings bool

    When true, the account level alert settings will be used, not the alert setting defined on this check.

    activated Boolean

    Determines if the check is running or not. Possible values true, and false.

    alertChannelSubscriptions List<Property Map>
    alertSettings Property Map
    degradedResponseTime Number

    The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 30000. (Default 15000).

    doubleCheck Boolean

    Setting this to true will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.

    environmentVariables Map<Any>

    Key/value pairs for setting environment variables during check execution. These are only relevant for browser checks. Use global environment variables whenever possible.

    Deprecated:

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

    frequency Number

    The frequency in minutes to run the check. Possible values are 0, 1, 2, 5, 10, 15, 30, 60, 120, 180, 360, 720, and 1440.

    frequencyOffset Number

    This property only valid for API high frequency checks. To create a hight frequency check, the property frequency must be 0 and frequency_offset could be 10, 20 or 30.

    groupId Number

    The id of the check group this check is part of.

    groupOrder Number

    The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.

    localSetupScript String

    A valid piece of Node.js code to run in the setup phase.

    localTeardownScript String

    A valid piece of Node.js code to run in the teardown phase.

    locations List<String>

    An array of one or more data center locations where to run the this check. (Default ["us-east-1"])

    maxResponseTime Number

    The response time in milliseconds starting from which a check should be considered failing. Possible values are between 0 and 30000. (Default 30000).

    muted Boolean

    Determines if any notifications will be sent out when a check fails/degrades/recovers.

    name String

    The name of the check.

    privateLocations List<String>

    An array of one or more private locations slugs.

    request Property Map

    An API check might have one request config.

    runtimeId String

    The id of the runtime to use for this check.

    script String

    A valid piece of Node.js JavaScript code describing a browser interaction with the Puppeteer/Playwright framework or a reference to an external JavaScript file.

    setupSnippetId Number

    An ID reference to a snippet to use in the setup phase of an API check.

    shouldFail Boolean

    Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.

    sslCheck Boolean

    Determines if the SSL certificate should be validated for expiry.

    Deprecated:

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

    tags List<String>

    A list of tags for organizing and filtering checks.

    teardownSnippetId Number

    An ID reference to a snippet to use in the teardown phase of an API check.

    type String

    The type of the check. Possible values are API, and BROWSER.

    useGlobalAlertSettings Boolean

    When true, the account level alert settings will be used, not the alert setting defined on this check.

    Supporting Types

    CheckAlertChannelSubscription, CheckAlertChannelSubscriptionArgs

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

    CheckAlertSettings, CheckAlertSettingsArgs

    escalationType String
    reminders List<Property Map>
    runBasedEscalations List<Property Map>
    sslCertificates List<Property Map>

    Deprecated:

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

    timeBasedEscalations List<Property Map>

    CheckAlertSettingsReminder, CheckAlertSettingsReminderArgs

    amount Integer
    interval Integer
    amount number
    interval number
    amount Number
    interval Number

    CheckAlertSettingsRunBasedEscalation, CheckAlertSettingsRunBasedEscalationArgs

    CheckAlertSettingsSslCertificate, CheckAlertSettingsSslCertificateArgs

    alertThreshold Integer
    enabled Boolean
    alertThreshold number
    enabled boolean
    alertThreshold Number
    enabled Boolean

    CheckAlertSettingsTimeBasedEscalation, CheckAlertSettingsTimeBasedEscalationArgs

    CheckRequest, CheckRequestArgs

    Url string
    Assertions List<CheckRequestAssertion>
    BasicAuth CheckRequestBasicAuth
    Body string
    BodyType string
    FollowRedirects bool
    Headers Dictionary<string, object>
    Method string
    QueryParameters Dictionary<string, object>
    SkipSsl bool
    Url string
    Assertions []CheckRequestAssertion
    BasicAuth CheckRequestBasicAuth
    Body string
    BodyType string
    FollowRedirects bool
    Headers map[string]interface{}
    Method string
    QueryParameters map[string]interface{}
    SkipSsl bool
    url string
    assertions CheckRequestAssertion[]
    basicAuth CheckRequestBasicAuth
    body string
    bodyType string
    followRedirects boolean
    headers {[key: string]: any}
    method string
    queryParameters {[key: string]: any}
    skipSsl boolean

    CheckRequestAssertion, CheckRequestAssertionArgs

    Comparison string
    Source string
    Property string
    Target string
    Comparison string
    Source string
    Property string
    Target string
    comparison String
    source String
    property String
    target String
    comparison string
    source string
    property string
    target string
    comparison String
    source String
    property String
    target String

    CheckRequestBasicAuth, CheckRequestBasicAuthArgs

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

    Package Details

    Repository
    checkly checkly/pulumi-checkly
    License
    MIT
    Notes

    This Pulumi package is based on the checkly Terraform Provider.

    checkly logo
    Checkly v1.1.4 published on Thursday, Mar 9, 2023 by checkly
    checkly/pulumi-checkly