Checkly (Independent Publisher) (Preview)
Checkly is the monitoring platform for the modern stack: programmable, flexible and loving JavaScript. Monitor and validate your crucial site transactions. Automatically collect error traces, screenshots and performance metrics with every check you run.
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Contact | |
---|---|
Name | Troy Taylor |
URL | https://www.hitachisolutions.com |
ttaylor@hitachisolutions.com |
Connector Metadata | |
---|---|
Publisher | Troy Taylor |
Website | https://www.checklyhq.com/ |
Privacy policy | https://www.checklyhq.com/privacy |
Categories | IT Operations |
The connector supports the following authentication types:
Default | Parameters for creating connection. | All regions | Not shareable |
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Type | Description | Required |
---|---|---|---|
Account ID | securestring | The Account ID for this API. | True |
API Key (in the form 'Bearer apiKey') | securestring | The API Key (in the form 'Bearer apiKey') for this api | True |
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Create a browser check |
Creates a new browser check. Will return a |
Create a check [DEPRECATED] |
[DEPRECATED] This endpoint will be removed on Monday 4 July 2022. Instead use |
Create a check group |
Creates a new check group. You can add checks to the group by setting the groupId property of individual checks. |
Create a dashboard |
Creates a new dashboard. Will return a 409 when attempting to create a dashboard with a custom URL or custom domain that is already taken. |
Create a environment variable |
Creates a new environment variable. |
Create a maintenance window |
Creates a new maintenance window. |
Create a private location |
Creates a new private location. |
Create a snippet |
Creates a new snippet. |
Create an alert channel |
Creates a new alert channel. |
Create an API check |
Creates a new API check. Will return a |
Create the check group trigger |
Creates the check group trigger. |
Create the check trigger |
Creates the check trigger. |
Delete a check |
Permanently removes a API or browser check and all its related status and results data. |
Delete a check group |
Permanently removes a check group. You cannot delete a check group if it still contains checks. |
Delete a dashboard |
Permanently removes a dashboard. |
Delete a maintenance window |
Permanently removes a maintenance window. |
Delete a snippet |
Permanently removes a snippet. |
Delete an alert channel |
Permanently removes an alert channel. |
Delete an environment variable |
Permanently removes an environment variable. Uses the key field as the identifier for deletion. |
Delete the check group trigger |
Deletes the check groups trigger. |
Delete the check trigger |
Deletes the check trigger. |
Generate a new API Key for a private location |
Creates an api key on the private location. |
Generates a customizable report for all Browser Check metrics |
Generates a report with aggregated or non-aggregated statistics for a specific Browser Check over a specified time window. |
Generates a report with aggregate statistics for checks and check groups |
Generates a report with aggregated statistics for all checks or a filtered set of checks over a specified time window. |
Get check status badge |
Get check status badge. |
Get group status badge |
Get group status badge. |
Get private location health metrics from a window of time |
Get private location health metrics from a window of time. |
Get the check group trigger |
Finds the check group trigger. |
Get the check trigger |
Finds the check trigger. |
List alerts for a specific check |
Lists all the alerts for a specific check. |
List all alert channels |
Lists all configured alert channels and their subscribed checks. |
List all alerts for your account |
Lists all alerts for your account. |
List all check groups |
Lists all current check groups in your account. The checks property is an array of check UUID's for convenient referencing. It is read only and you cannot use it to add checks to a group. |
List all check statuses |
Shows the current status information for all checks in your account. The check status records are continuously updated as new check results come in. |
List all checks |
Lists all current checks in your account. |
List all dashboards |
Lists all current dashboards in your account. |
List all environment variables |
Lists all current environment variables in your account. |
List all maintenance windows |
Lists all maintenance windows in your account. |
List all private locations |
Lists all private locations in your account. |
List all snippets |
Lists all current snippets in your account. |
Lists all check results |
Lists the full, raw check results for a specific check. We keep raw results for 30 days. After 30 days they are erased. However we keep the rolled up results for an indefinite period. You can filter by check type and result type to narrow down the list. Use the |
Lists all supported locations |
Lists all supported locations. |
Lists all supported runtimes |
Lists all supported runtimes and the included NPM packages for Browser checks and setup & teardown scripts for API checks. |
Remove a private location |
Permanently removes a private location. |
Remove an existing API key for a private location |
Permanently removes an api key from a private location. |
Retrieve a check |
Show details of a specific API or browser check. |
Retrieve a check group |
Show details of a specific check group. |
Retrieve a check result |
Show details of a specific check result. |
Retrieve a maintenance window |
Show details of a specific maintenance window. |
Retrieve a private location |
Show details of a specific private location. |
Retrieve a snippet |
Show details of a specific snippet. |
Retrieve all checks in a specific group with group settings applied |
Lists all checks in a specific check group with the group settings applied. |
Retrieve an alert channel |
Show details of a specific alert channel. |
Retrieve an environment variable |
Show details of a specific environment variable. Uses the key field for selection. |
Retrieve check status details |
Show the current status information for a specific check. |
Retrieve one check in a specific group with group settings applied |
Show details of one check in a specific check group with the group settings applied. |
Shows details for one specific runtime |
Shows the details of all included NPM packages and their version for one specific runtime. |
Update a browser check |
Updates a browser check. |
Update a check [DEPRECATED] |
[DEPRECATED] This endpoint will be removed on Monday 4 July 2022. Instead use |
Update a check group |
Updates a check group. |
Update a dashboard |
Updates a dashboard. Will return a 409 when attempting to create a dashboard with a custom URL or custom domain that is already taken. |
Update a environment variable |
Updates an environment variable. Uses the key field as the identifier for updating. Only updates value and locked property. |
Update a maintenance window |
Updates a maintenance window. |
Update a private location |
Updates a private location. |
Update a snippet |
Updates a snippet. |
Update an alert channel |
Update an alert channel. |
Update an API check |
Updates an API check. |
Update the subscriptions of an alert channel |
Update the subscriptions of an alert channel. Use this to add a check to an alert channel so failure and recovery alerts are send out for that check. Note: when passing the subscription object, you can only specify a checkId or a groupId, not both. |
Creates a new browser check. Will return a 402
when you are over the limit of your plan. When using the globalAlertSetting
, the alertSetting
can be null
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Auto-assign Alerts
|
autoAssignAlerts | boolean |
Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created. |
|
Name
|
name | True | string |
The name of the check. |
Activated
|
activated | True | boolean |
Determines if the check is running or not. |
Muted
|
muted | boolean |
Determines if any notifications will be send out when a check fails and/or recovers. |
|
Double Check
|
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. |
|
Should Fail
|
shouldFail | boolean |
Allows to invert the behavior of when a check is considered to fail. Allows for validating error status like 404. |
|
Check Location List
|
locations | array of string |
An array of one or more data center locations where to run this check. |
|
Check Tag List
|
tags | array of string |
Tags for organizing and filtering checks. |
|
Escalation Type
|
escalationType | string |
Determines what type of escalation to use. |
|
Failed Run Threshold
|
failedRunThreshold | number |
After how many failed consecutive check runs an alert notification should be send. |
|
Minutes Failing Threshold
|
minutesFailingThreshold | number |
After how many minutes after a check starts failing an alert should be send. |
|
Amount
|
amount | number |
How many reminders to send out after the initial alert notification. |
|
Interval
|
interval | number |
At what interval the reminders should be send. |
|
Enabled
|
enabled | boolean |
Determines if alert notifications should be send for expiring SSL certificates. |
|
Alert Threshold
|
alertThreshold | integer |
At what moment in time to start alerting on SSL certificates. |
|
Use Global Alert Settings
|
useGlobalAlertSettings | boolean |
When true, the account level alert setting will be used, not the alert setting defined on this check. |
|
Group ID
|
groupId | number |
The identifier of the check group this check is part of. |
|
Group Order
|
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. |
|
Runtime ID
|
runtimeId | string |
The runtime version, i.e. fixed set of runtime dependencies, used to execute this check. |
|
Alert Channel ID
|
alertChannelId | True | number |
The alert channel identifier. |
Activated
|
activated | True | boolean |
Whether activated. |
Key
|
key | True | string |
The key of the environment variable (this value cannot be changed). |
Value
|
value | True | string |
The value of the environment variable. |
Locked
|
locked | boolean |
Used only in the UI to hide the value like a password. |
|
Frequency
|
frequency | integer |
How often the check should run in minutes. |
|
Script
|
script | True | string |
A valid piece of Node.js javascript code describing a browser interaction with the Puppeteer or Playwright frameworks. |
Private Locations
|
privateLocations | array of string |
An array of one or more private locations where to run the check. |
Returns
- Body
- CheckBrowser
[DEPRECATED] This endpoint will be removed on Monday 4 July 2022. Instead use POST /checks/api
or POST /checks/browser
. Creates a new API or browser check. Will return a 402
when you are over the limit of your plan. When using the globalAlertSettings
, the alertSettings
can be null
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Auto-assign Alerts
|
autoAssignAlerts | boolean |
Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created. |
|
Name
|
name | True | string |
The name of the check. |
Activated
|
activated | True | boolean |
Determines if the check is running or not. |
Muted
|
muted | boolean |
Determines if any notifications will be send out when a check fails and/or recovers. |
|
Double Check
|
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. |
|
Should Fail
|
shouldFail | boolean |
Allows to invert the behavior of when a check is considered to fail. Allows for validating error status like 404. |
|
Check Location List
|
locations | array of string |
An array of one or more data center locations where to run this check. |
|
Check Tag List
|
tags | array of string |
Tags for organizing and filtering checks. |
|
Escalation Type
|
escalationType | string |
Determines what type of escalation to use. |
|
Failed Run Threshold
|
failedRunThreshold | number |
After how many failed consecutive check runs an alert notification should be send. |
|
Minutes Failing Threshold
|
minutesFailingThreshold | number |
After how many minutes after a check starts failing an alert should be send. |
|
Amount
|
amount | number |
How many reminders to send out after the initial alert notification. |
|
Interval
|
interval | number |
At what interval the reminders should be send. |
|
Enabled
|
enabled | boolean |
Determines if alert notifications should be send for expiring SSL certificates. |
|
Alert Threshold
|
alertThreshold | integer |
At what moment in time to start alerting on SSL certificates. |
|
Use Global Alert Settings
|
useGlobalAlertSettings | boolean |
When true, the account level alert setting will be used, not the alert setting defined on this check. |
|
Group ID
|
groupId | number |
The identifier of the check group this check is part of. |
|
Group Order
|
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. |
|
Runtime ID
|
runtimeId | string |
The runtime version, i.e. fixed set of runtime dependencies, used to execute this check. |
|
Alert Channel ID
|
alertChannelId | True | number |
The alert channel identifier. |
Activated
|
activated | True | boolean |
Whether activated. |
Check Type
|
checkType | True | string |
The type of the check. |
Frequency
|
frequency | integer |
How often the check should run in minutes. |
|
Frequency Offset
|
frequencyOffset | integer |
Used for setting seconds for check frequencies under 1 minutes (only for API checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula Math.floor(frequency * 10), i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula Math.ceil(frequency / 60), i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. |
|
Check Request
|
request | object |
The check request. |
|
Script
|
script | True | string |
The script. |
Key
|
key | True | string |
The key of the environment variable (this value cannot be changed). |
Value
|
value | True | string |
The value of the environment variable. |
Locked
|
locked | boolean |
Used only in the UI to hide the value like a password. |
|
Setup Snippet ID
|
setupSnippetId | number |
An identifier reference to a snippet to use in the setup phase of an API check. |
|
Tear Down Snippet ID
|
tearDownSnippetId | number |
An identifier reference to a snippet to use in the teardown phase of an API check. |
|
Local Setup Script
|
localSetupScript | string |
A valid piece of Node.js code to run in the setup phase. |
|
Local Tear Down Script
|
localTearDownScript | string |
A valid piece of Node.js code to run in the teardown phase. |
|
Degraded Response Time
|
degradedResponseTime | number |
The response time in milliseconds where a check should be considered degraded. |
|
Max Response Time
|
maxResponseTime | number |
The response time in milliseconds where a check should be considered failing. |
|
Private Locations
|
privateLocations | array of string |
An array of one or more private locations where to run the check. |
Returns
- Body
- Check
Creates a new check group. You can add checks to the group by setting the groupId property of individual checks.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Auto-assign Alerts
|
autoAssignAlerts | boolean |
Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created. |
|
Name
|
name | True | string |
The name of the check group. |
Activated
|
activated | boolean |
Determines if the checks in the group are running or not. |
|
Muted
|
muted | boolean |
Determines if any notifications will be send out when a check in this group fails and/or recovers. |
|
Check Group Tag List
|
tags | array of string |
Tags for organizing and filtering checks. |
|
Check Group Location List
|
locations | array of string |
An array of one or more data center locations where to run the checks. |
|
Concurrency
|
concurrency | number |
Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API. |
|
URL
|
url | string |
The base URL for this group which you can reference with the {{GROUP_BASE_URL}} variable in all group checks. |
|
Key
|
key | True | string |
The key. |
Value
|
value | True | string |
The value. |
Locked
|
locked | boolean |
Whether locked. |
|
Source
|
source | string |
The source. |
|
Property
|
property | string |
The property. |
|
Comparison
|
comparison | string |
The comparison. |
|
Target
|
target | string |
The target. |
|
Username
|
username | True | string |
The username. |
Password
|
password | True | string |
The password. |
Check Group Create Browser Check Defaults
|
browserCheckDefaults | object |
The check group create browser check defaults. |
|
Runtime ID
|
runtimeId | string |
The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group. |
|
Key
|
key | True | string |
The key of the environment variable (this value cannot be changed). |
Value
|
value | True | string |
The value of the environment variable. |
Locked
|
locked | boolean |
Used only in the UI to hide the value like a password. |
|
Double Check
|
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. |
|
Use Global Alert Settings
|
useGlobalAlertSettings | boolean |
When true, the account level alert setting will be used, not the alert setting defined on this check group. |
|
Escalation Type
|
escalationType | string |
Determines what type of escalation to use. |
|
Failed Run Threshold
|
failedRunThreshold | number |
After how many failed consecutive check runs an alert notification should be send. |
|
Minutes Failing Threshold
|
minutesFailingThreshold | number |
After how many minutes after a check starts failing an alert should be send. |
|
Amount
|
amount | number |
How many reminders to send out after the initial alert notification. |
|
Interval
|
interval | number |
At what interval the reminders should be send. |
|
Enabled
|
enabled | boolean |
Determines if alert notifications should be send for expiring SSL certificates. |
|
Alert Threshold
|
alertThreshold | integer |
At what moment in time to start alerting on SSL certificates. |
|
Alert Channel ID
|
alertChannelId | True | number |
The alert channel identifier. |
Activated
|
activated | True | boolean |
Whether activated. |
Setup Snippet ID
|
setupSnippetId | number |
An identifier reference to a snippet to use in the setup phase of an API check in this group. |
|
Tear Down Snippet ID
|
tearDownSnippetId | number |
An identifier reference to a snippet to use in the teardown phase of an API check in this group. |
|
Local Setup Script
|
localSetupScript | string |
A valid piece of Node.js code to run in the setup phase of an API check in this group. |
|
Local Tear Down Script
|
localTearDownScript | string |
A valid piece of Node.js code to run in the teardown phase of an API check in this group. |
|
Check Private Locations
|
privateLocations | array of string |
An array of one or more private locations where to run the checks. |
Returns
- Body
- CheckGroup
Creates a new dashboard. Will return a 409 when attempting to create a dashboard with a custom URL or custom domain that is already taken.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Custom URL
|
customUrl | string |
A subdomain name under checklyhq.com. Needs to be unique across all users. |
|
Custom Domain
|
customDomain | string |
A custom user domain, e.g. status.example.com. See the docs on updating your DNS and SSL usage. |
|
Logo
|
logo | string |
A URL pointing to an image file. |
|
Favicon
|
favicon | string |
A URL pointing to an image file used as dashboard favicon. |
|
Link
|
link | string |
A URL link to redirect when dashboard logo is clicked on. |
|
Header
|
header | string |
A piece of text displayed at the top of your dashboard. |
|
Description
|
description | string |
A piece of text displayed below the header or title of your dashboard. |
|
Width
|
width | string |
Determines whether to use the full screen or focus in the center. |
|
Refresh Rate
|
refreshRate | number |
How often to refresh the dashboard in seconds. |
|
Paginate
|
paginate | boolean |
Determines of pagination is on or off. |
|
Pagination Rate
|
paginationRate | number |
How often to trigger pagination in seconds. |
|
Checks per Page
|
checksPerPage | number |
Number of checks displayed per page. |
|
Use And Operator
|
useTagsAndOperator | boolean |
When to use AND operator for tags lookup. |
|
Hide Tags
|
hideTags | boolean |
Show or hide the tags on the dashboard. |
|
Dashboard Tag List
|
tags | array of string |
A list of one or more tags that filter which checks to display on the dashboard. |
Returns
- Body
- Dashboard
Creates a new environment variable.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Key
|
key | True | string |
The key of the environment variable (this value cannot be changed). |
Value
|
value | True | string |
The value of the environment variable. |
Locked
|
locked | boolean |
Used only in the UI to hide the value like a password. |
Returns
- Body
- EnvironmentVariable
Creates a new maintenance window.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Name
|
name | True | string |
The maintenance window name. |
Maintenance Window Tag List
|
tags | array of string |
The names of the checks and groups maintenance window should apply to. |
|
Starts At
|
startsAt | True | date |
The start date of the maintenance window. |
Ends At
|
endsAt | True | date |
The end date of the maintenance window. |
Repeat Interval
|
repeatInterval | number |
The repeat interval of the maintenance window from the first occurrence. |
|
Repeat Unit
|
repeatUnit | True | string |
The repeat strategy for the maintenance window. |
Repeat Ends At
|
repeatEndsAt | date |
The end date where the maintenance window should stop repeating. |
Returns
- Body
- MaintenanceWindow
Creates a new private location.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Name
|
name | True | string |
The name assigned to the private location. |
Slug Name
|
slugName | True | string |
Valid slug name. |
Icon
|
icon | string |
The icon. |
Returns
Creates a new snippet.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Name
|
name | True | string |
The snippet name. |
Script
|
script | True | string |
Your Node.js code that interacts with the API check lifecycle, or functions as a partial for browser checks. |
Returns
- Body
- Snippet
Creates a new alert channel.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
id | number |
The identifier. |
|
Check ID
|
checkId | guid |
The check identifier. |
|
Group ID
|
groupId | number |
The group identifier. |
|
Activated
|
activated | True | boolean |
Whether activated. |
Type
|
type | True | string |
The type. |
Alert Channel Create Config
|
config | True | object |
The alert channel create config. |
Send Recovery
|
sendRecovery | boolean |
Whether send recovery. |
|
Send Failure
|
sendFailure | boolean |
Whether send failure. |
|
Send Degraded
|
sendDegraded | boolean |
Whether send degraded. |
|
SSL Expiry
|
sslExpiry | boolean |
Determines if an alert should be send for expiring SSL certificates. |
|
SSL Expiry Threshold
|
sslExpiryThreshold | integer |
At what moment in time to start alerting on SSL certificates. |
Returns
- Body
- AlertChannel
Creates a new API check. Will return a 402
when you are over the limit of your plan. When using the globalAlertSetting
, the alertSetting
can be null
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Auto-assign Alerts
|
autoAssignAlerts | boolean |
Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created. |
|
Name
|
name | True | string |
The name of the check. |
Activated
|
activated | True | boolean |
Determines if the check is running or not. |
Muted
|
muted | boolean |
Determines if any notifications will be send out when a check fails and/or recovers. |
|
Double Check
|
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. |
|
Should Fail
|
shouldFail | boolean |
Allows to invert the behavior of when a check is considered to fail. Allows for validating error status like 404. |
|
Check Location List
|
locations | array of string |
An array of one or more data center locations where to run this check. |
|
Check Tag List
|
tags | array of string |
Tags for organizing and filtering checks. |
|
Escalation Type
|
escalationType | string |
Determines what type of escalation to use. |
|
Failed Run Threshold
|
failedRunThreshold | number |
After how many failed consecutive check runs an alert notification should be send. |
|
Minutes Failing Threshold
|
minutesFailingThreshold | number |
After how many minutes after a check starts failing an alert should be send. |
|
Amount
|
amount | number |
How many reminders to send out after the initial alert notification. |
|
Interval
|
interval | number |
At what interval the reminders should be send. |
|
Enabled
|
enabled | boolean |
Determines if alert notifications should be send for expiring SSL certificates. |
|
Alert Threshold
|
alertThreshold | integer |
At what moment in time to start alerting on SSL certificates. |
|
Use Global Alert Settings
|
useGlobalAlertSettings | boolean |
When true, the account level alert setting will be used, not the alert setting defined on this check. |
|
Group ID
|
groupId | number |
The identifier of the check group this check is part of. |
|
Group Order
|
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. |
|
Runtime ID
|
runtimeId | string |
The runtime version, i.e. fixed set of runtime dependencies, used to execute this check. |
|
Alert Channel ID
|
alertChannelId | True | number |
The alert channel identifier. |
Activated
|
activated | True | boolean |
Whether activated. |
method
|
method | True | string | |
URL
|
url | True | string |
The URL address. |
Follow Redirects
|
followRedirects | boolean |
Whether follows redirects. |
|
Skip SSL
|
skipSSL | boolean |
Whether to skip SSL. |
|
Body
|
body | string |
The body. |
|
bodyType
|
bodyType | string | ||
Key
|
key | True | string |
The key. |
Value
|
value | True | string |
The value. |
Locked
|
locked | boolean |
Whether locked. |
|
Source
|
source | string |
The source. |
|
Property
|
property | string |
The property. |
|
Comparison
|
comparison | string |
The comparison. |
|
Target
|
target | string |
The target. |
|
Username
|
username | True | string |
The username. |
Password
|
password | True | string |
The password. |
Frequency
|
frequency | integer |
How often the check should run in minutes. |
|
Tear Down Snippet ID
|
tearDownSnippetId | number |
An identifier reference to a snippet to use in the teardown phase of an API check. |
|
Setup Snippet ID
|
setupSnippetId | number |
An identifier reference to a snippet to use in the setup phase of an API check. |
|
Frequency Offset
|
frequencyOffset | integer |
Used for setting seconds for check frequencies under 1 minutes and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula Math.floor(frequency * 10), i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula Math.ceil(frequency / 60), i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. |
|
Local Setup Script
|
localSetupScript | string |
A valid piece of Node.js code to run in the setup phase. |
|
Local Tear Down Script
|
localTearDownScript | string |
A valid piece of Node.js code to run in the teardown phase. |
|
Degraded Response Time
|
degradedResponseTime | number |
The response time in milliseconds where a check should be considered degraded. |
|
Max Response Time
|
maxResponseTime | number |
The response time in milliseconds where a check should be considered failing. |
|
Private Locations
|
privateLocations | array of string |
An array of one or more private locations where to run the check. |
Returns
- Body
- CheckAPI
Creates the check group trigger.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Group ID
|
groupId | True | integer |
The group identifier. |
Returns
- Body
- CheckGroupTrigger
Creates the check trigger.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Check ID
|
checkId | True | string |
The check identifier. |
Returns
- Body
- CheckTrigger
Permanently removes a API or browser check and all its related status and results data.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
id | True | string |
The identifier. |
Permanently removes a check group. You cannot delete a check group if it still contains checks.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
id | True | integer |
The identifier. |
Permanently removes a dashboard.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
dashboardId | True | string |
The dashboard identifier. |
Permanently removes a maintenance window.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
id | True | integer |
The identifier. |
Permanently removes a snippet.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
id | True | integer |
The identifier. |
Permanently removes an alert channel.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
id | True | integer |
The identifier. |
Permanently removes an environment variable. Uses the key field as the identifier for deletion.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Key
|
key | True | string |
The key. |
Deletes the check groups trigger.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Group ID
|
groupId | True | integer |
The group identifier. |
Deletes the check trigger.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Check ID
|
checkId | True | string |
The check identifier. |
Creates an api key on the private location.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
id | True | string |
The identifier. |
Returns
- Body
- privateLocationKeys
Generates a report with aggregated or non-aggregated statistics for a specific Browser Check over a specified time window.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
id | True | string |
The identifier. |
From
|
from | date |
Custom start time of reporting window in unix timestamp format. Setting a custom from timestamp overrides the use of any presetWindow. |
|
To
|
to | date |
Custom end time of reporting window in unix timestamp format. Setting a custom to timestamp overrides the use of any presetWindow. |
|
Preset Window
|
presetWindow | string |
Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom to and from timestamp. |
|
Aggregation Interval
|
aggregationInterval | number |
The time interval to use for aggregating metrics in minutes. For example, five minutes is 300, 24 hours is 1440. |
|
Group By
|
groupBy | string |
Determines how the series data is grouped. |
|
Filter by Status
|
filterByStatus | array |
Use status to filter for check either failing or successful check result data. |
|
Metrics
|
metrics | array |
metrics options for browser checks. |
Returns
The attributes.
- Attributes
- object
Generates a report with aggregated statistics for all checks or a filtered set of checks over a specified time window.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
From
|
from | date |
Custom start time of reporting window in unix timestamp format. Setting a custom from timestamp overrides the use of any presetWindow. |
|
To
|
to | date |
Custom end time of reporting window in unix timestamp format. Setting a custom to timestamp overrides the use of any presetWindow. |
|
Preset Window
|
presetWindow | string |
Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom to and from timestamp. |
|
Filter by Tags
|
filterByTags | array |
Use tags to filter the checks you want to see in your report. |
|
Deactivated
|
deactivated | boolean |
Filter checks by activated status. |
Returns
- Items
- ReportingList
Get check status badge.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Check ID
|
checkId | True | string |
The check identifier. |
Style
|
style | string |
The style. |
|
Theme
|
theme | string |
The theme. |
|
Response Time
|
responseTime | boolean |
The response time. |
Returns
- response
- string
Get group status badge.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Group ID
|
groupId | True | integer |
The group identifier. |
Style
|
style | string |
The style. |
|
Theme
|
theme | string |
The theme. |
|
Response Time
|
responseTime | boolean |
The response time. |
Returns
- response
- string
Get private location health metrics from a window of time.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
id | True | string |
The identifier. |
From
|
from | True | date |
Select metrics beginning with this UNIX timestamp. Must be less than 15 days ago. |
To
|
to | True | date |
Select metrics up to this UNIX timestamp. |
Returns
Finds the check group trigger.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Group ID
|
groupId | True | integer |
The group identifier. |
Returns
- Body
- CheckGroupTrigger
Finds the check trigger.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Check ID
|
checkId | True | string |
The check identifier. |
Returns
- Body
- CheckTrigger
Lists all the alerts for a specific check.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Check ID
|
checkId | True | string |
The check identifier. |
Limit
|
limit | integer |
Limit the number of results. |
|
Number
|
page | number |
The page number. |
|
From
|
from | date |
Select documents up from this UNIX timestamp (>= date). Defaults to now - 6 hours. |
|
To
|
to | date |
Select alerts up to this UNIX timestamp (< date). Defaults to 6 hours after from. |
Returns
- Items
- CheckAlertList
Lists all configured alert channels and their subscribed checks.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Limit
|
limit | integer |
Limit the number of results. |
|
Number
|
page | number |
The page number. |
Returns
- Items
- AlertChannelList
Lists all alerts for your account.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Limit
|
limit | integer |
Limit the number of results. |
|
Number
|
page | number |
The page number. |
|
From
|
from | date |
Select documents up from this UNIX timestamp (>= date). Defaults to now - 6 hours. |
|
To
|
to | date |
Select alerts up to this UNIX timestamp (< date). Defaults to 6 hours after from. |
Returns
- Items
- CheckAlertList
Lists all current check groups in your account. The checks property is an array of check UUID's for convenient referencing. It is read only and you cannot use it to add checks to a group.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Limit
|
limit | integer |
Limit the number of results. |
|
Number
|
page | number |
The page number. |
Returns
- Items
- CheckGroupList
Shows the current status information for all checks in your account. The check status records are continuously updated as new check results come in.
Returns
- Items
- CheckStatusList
Lists all current checks in your account.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Limit
|
limit | integer |
Limit the number of results. |
|
Number
|
page | number |
The page number. |
|
API Check URL Filter
|
apiCheckUrlFilterPattern | string |
Filters the results by a string contained in the URL of an API check, for instance a domain like www.myapp.com. Only returns API checks. |
Returns
- Items
- CheckList
Lists all current dashboards in your account.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Limit
|
limit | integer |
Limit the number of results. |
|
Number
|
page | number |
The page number. |
Returns
- Items
- DashboardsList
Lists all current environment variables in your account.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Limit
|
limit | integer |
Limit the number of results. |
|
Number
|
page | number |
The page number. |
Returns
- Items
- EnvironmentVariableList
Lists all maintenance windows in your account.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Limit
|
limit | integer |
Limit the number of results. |
|
Number
|
page | number |
The page number. |
Returns
The maintenance window list.
- Items
- MaintenanceWindowList
Lists all current snippets in your account.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Limit
|
limit | integer |
Limit the number of results. |
|
Number
|
page | number |
The page number. |
Returns
- Items
- SnippetList
Lists the full, raw check results for a specific check. We keep raw results for 30 days. After 30 days they are erased. However we keep the rolled up results for an indefinite period. You can filter by check type and result type to narrow down the list. Use the to
and from
parameters to specify a date range (UNIX timestamp in seconds). Depending on the check type, some fields might be null. This endpoint will return data within a six-hours timeframe. If from and to params are set, they must be at most six hours apart.If none are set, we will consider the to param to be now and from param to be six hours earlier. If only the to param is set we will set from to be six hours earlier. On the contrary, if only the from param is set we will consider the to param to be six hours later. Rate-limiting is applied to this endpoint, you can send 5 requests / 10 seconds at most.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Check ID
|
checkId | True | string |
The check identifier. |
Limit
|
limit | integer |
Limit the number of results. |
|
Number
|
page | number |
The page number. |
|
From
|
from | date |
Select documents up from this UNIX timestamp (>= date). Defaults to now - 6 hours. |
|
To
|
to | date |
Select alerts up to this UNIX timestamp (< date). Defaults to 6 hours after from. |
|
Location
|
location | string |
Provide a data center location, e.g. eu-west-1 to filter by location |
|
Check Type
|
checkType | string |
The type of the check. |
|
Has Failures
|
hasFailures | boolean |
Check result has one or more failures. |
Returns
- Items
- CheckResultList
Lists all supported runtimes and the included NPM packages for Browser checks and setup & teardown scripts for API checks.
Returns
- Items
- RuntimeList
Permanently removes a private location.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
id | True | string |
The identifier. |
Permanently removes an api key from a private location.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
id | True | string |
The identifier. |
Key ID
|
keyId | True | string |
The key identifier. |
Show details of a specific API or browser check.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
id | True | string |
The identifier. |
Returns
- Body
- Check
Show details of a specific check group.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
id | True | integer |
The identifier. |
Returns
- Body
- CheckGroup
Show details of a specific check result.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Check ID
|
checkId | True | string |
The check identifier. |
Check Result ID
|
checkResultId | True | string |
The check result identifier. |
Returns
- Body
- CheckResult
Show details of a specific maintenance window.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
id | True | integer |
The identifier. |
Returns
- Body
- MaintenanceWindow
Show details of a specific private location.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
id | True | string |
The identifier. |
Returns
Show details of a specific snippet.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
id | True | integer |
The identifier. |
Returns
- Body
- Snippet
Lists all checks in a specific check group with the group settings applied.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
id | True | integer |
The identifier. |
Limit
|
limit | integer |
Limit the number of results. |
|
Number
|
page | number |
The page number. |
Returns
- Items
- Model8
Show details of a specific alert channel.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
id | True | integer |
The identifier. |
Returns
- Body
- AlertChannel
Show details of a specific environment variable. Uses the key field for selection.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Key
|
key | True | string |
The key. |
Returns
- Body
- EnvironmentVariable
Show the current status information for a specific check.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Check ID
|
checkId | True | string |
The check identifier. |
Returns
- Body
- CheckStatus
Show details of one check in a specific check group with the group settings applied.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Group ID
|
groupId | True | integer |
The group identifier. |
Check ID
|
checkId | True | string |
The check identifier. |
Returns
- Body
- CheckGroupCheck
Shows the details of all included NPM packages and their version for one specific runtime.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
id | True | string |
The identifier. |
Returns
- Body
- Runtime
Updates a browser check.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
id | True | string |
The identifier. |
Auto-assign Alerts
|
autoAssignAlerts | boolean |
Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created. |
|
Name
|
name | string |
The name of the check. |
|
Activated
|
activated | boolean |
Determines if the check is running or not. |
|
Muted
|
muted | boolean |
Determines if any notifications will be send out when a check fails and/or recovers. |
|
Double Check
|
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. |
|
Should Fail
|
shouldFail | boolean |
Allows to invert the behavior of when a check is considered to fail. Allows for validating error status like 404. |
|
Check Location List
|
locations | array of string |
An array of one or more data center locations where to run this check. |
|
Check Tag List
|
tags | array of string |
Tags for organizing and filtering checks. |
|
Escalation Type
|
escalationType | string |
Determines what type of escalation to use. |
|
Failed Run Threshold
|
failedRunThreshold | number |
After how many failed consecutive check runs an alert notification should be send. |
|
Minutes Failing Threshold
|
minutesFailingThreshold | number |
After how many minutes after a check starts failing an alert should be send. |
|
Amount
|
amount | number |
How many reminders to send out after the initial alert notification. |
|
Interval
|
interval | number |
At what interval the reminders should be send. |
|
Enabled
|
enabled | boolean |
Determines if alert notifications should be send for expiring SSL certificates. |
|
Alert Threshold
|
alertThreshold | integer |
At what moment in time to start alerting on SSL certificates. |
|
Use Global Alert Settings
|
useGlobalAlertSettings | boolean |
When true, the account level alert setting will be used, not the alert setting defined on this check. |
|
Group ID
|
groupId | number |
The identifier of the check group this check is part of. |
|
Group Order
|
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. |
|
Runtime ID
|
runtimeId | string |
The runtime version, i.e. fixed set of runtime dependencies, used to execute this check. |
|
Alert Channel ID
|
alertChannelId | True | number |
The alert channel identifier. |
Activated
|
activated | True | boolean |
Whether activated. |
Key
|
key | True | string |
The key of the environment variable (this value cannot be changed). |
Value
|
value | True | string |
The value of the environment variable. |
Locked
|
locked | boolean |
Used only in the UI to hide the value like a password. |
|
Frequency
|
frequency | integer |
How often the check should run in minutes. |
|
Script
|
script | string |
A valid piece of Node.js javascript code describing a browser interaction with the Puppeteer or Playwright frameworks. |
|
Private Locations
|
privateLocations | array of string |
An array of one or more private locations where to run the check. |
Returns
- Body
- CheckBrowser
[DEPRECATED] This endpoint will be removed on Monday 4 July 2022. Instead use PUT /checks/api/{id}
or PUT /checks/browser/{id}
. Updates a new API or browser check.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
id | True | string |
The identifier. |
Auto-assign Alerts
|
autoAssignAlerts | boolean |
Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created. |
|
Name
|
name | string |
The name of the check. |
|
Activated
|
activated | boolean |
Determines if the check is running or not. |
|
Muted
|
muted | boolean |
Determines if any notifications will be send out when a check fails and/or recovers. |
|
Double Check
|
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. |
|
Should Fail
|
shouldFail | boolean |
Allows to invert the behavior of when a check is considered to fail. Allows for validating error status like 404. |
|
Check Location List
|
locations | array of string |
An array of one or more data center locations where to run this check. |
|
Check Tag List
|
tags | array of string |
Tags for organizing and filtering checks. |
|
Escalation Type
|
escalationType | string |
Determines what type of escalation to use. |
|
Failed Run Threshold
|
failedRunThreshold | number |
After how many failed consecutive check runs an alert notification should be send. |
|
Minutes Failing Threshold
|
minutesFailingThreshold | number |
After how many minutes after a check starts failing an alert should be send. |
|
Amount
|
amount | number |
How many reminders to send out after the initial alert notification. |
|
Interval
|
interval | number |
At what interval the reminders should be send. |
|
Enabled
|
enabled | boolean |
Determines if alert notifications should be send for expiring SSL certificates. |
|
Alert Threshold
|
alertThreshold | integer |
At what moment in time to start alerting on SSL certificates. |
|
Use Global Alert Settings
|
useGlobalAlertSettings | boolean |
When true, the account level alert setting will be used, not the alert setting defined on this check. |
|
Group ID
|
groupId | number |
The identifier of the check group this check is part of. |
|
Group Order
|
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. |
|
Runtime ID
|
runtimeId | string |
The runtime version, i.e. fixed set of runtime dependencies, used to execute this check. |
|
Alert Channel ID
|
alertChannelId | True | number |
The alert channel identifier. |
Activated
|
activated | True | boolean |
Whether activated. |
Check Type
|
checkType | string |
The type of the check. |
|
Frequency
|
frequency | integer |
How often the check should run in minutes. |
|
Frequency Offset
|
frequencyOffset | integer |
Used for setting seconds for check frequencies under 1 minutes (only for API checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula Math.floor(frequency * 10), i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula Math.ceil(frequency / 60), i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. |
|
Check Request
|
request | True | object |
The check request. |
Script
|
script | True | string |
The script. |
Key
|
key | True | string |
The key of the environment variable (this value cannot be changed). |
Value
|
value | True | string |
The value of the environment variable. |
Locked
|
locked | boolean |
Used only in the UI to hide the value like a password. |
|
Setup Snippet ID
|
setupSnippetId | number |
An identifier reference to a snippet to use in the setup phase of an API check. |
|
Tear Down Snippet ID
|
tearDownSnippetId | number |
An identifier reference to a snippet to use in the teardown phase of an API check. |
|
Local Setup Script
|
localSetupScript | string |
A valid piece of Node.js code to run in the setup phase. |
|
Local Tear Down Script
|
localTearDownScript | string |
A valid piece of Node.js code to run in the teardown phase. |
|
Degraded Response Time
|
degradedResponseTime | number |
The response time in milliseconds where a check should be considered degraded. |
|
Max Response Time
|
maxResponseTime | number |
The response time in milliseconds where a check should be considered failing. |
|
Private Locations
|
privateLocations | array of string |
An array of one or more private locations where to run the check. |
Returns
- Body
- Check
Updates a check group.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
id | True | integer |
The identifier. |
Auto-assign Alerts
|
autoAssignAlerts | boolean |
Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created. |
|
Name
|
name | string |
The name of the check group. |
|
Activated
|
activated | boolean |
Determines if the checks in the group are running or not. |
|
Muted
|
muted | boolean |
Determines if any notifications will be send out when a check in this group fails and/or recovers. |
|
Check Group Tag List
|
tags | array of string |
Tags for organizing and filtering checks. |
|
Check Group Location List
|
locations | array of string |
An array of one or more data center locations where to run the checks. |
|
Concurrency
|
concurrency | number |
Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API. |
|
URL
|
url | string |
The base URL for this group which you can reference with the {{GROUP_BASE_URL}} variable in all group checks. |
|
Key
|
key | True | string |
The key. |
Value
|
value | True | string |
The value. |
Locked
|
locked | boolean |
Whether locked. |
|
Source
|
source | string |
The source. |
|
Property
|
property | string |
The property. |
|
Comparison
|
comparison | string |
The comparison. |
|
Target
|
target | string |
The target. |
|
Username
|
username | True | string |
The username. |
Password
|
password | True | string |
The password. |
Check Group Create Browser Check Defaults
|
browserCheckDefaults | object |
The check group create browser check defaults. |
|
Runtime ID
|
runtimeId | string |
The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group. |
|
Key
|
key | True | string |
The key of the environment variable (this value cannot be changed). |
Value
|
value | True | string |
The value of the environment variable. |
Locked
|
locked | boolean |
Used only in the UI to hide the value like a password. |
|
Double Check
|
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. |
|
Use Global Alert Settings
|
useGlobalAlertSettings | boolean |
When true, the account level alert setting will be used, not the alert setting defined on this check group. |
|
Escalation Type
|
escalationType | string |
Determines what type of escalation to use. |
|
Failed Run Threshold
|
failedRunThreshold | number |
After how many failed consecutive check runs an alert notification should be send. |
|
Minutes Failing Threshold
|
minutesFailingThreshold | number |
After how many minutes after a check starts failing an alert should be send. |
|
Amount
|
amount | number |
How many reminders to send out after the initial alert notification. |
|
Interval
|
interval | number |
At what interval the reminders should be send. |
|
Enabled
|
enabled | boolean |
Determines if alert notifications should be send for expiring SSL certificates. |
|
Alert Threshold
|
alertThreshold | integer |
At what moment in time to start alerting on SSL certificates. |
|
Alert Channel ID
|
alertChannelId | True | number |
The alert channel identifier. |
Activated
|
activated | True | boolean |
Whether activated. |
Setup Snippet ID
|
setupSnippetId | number |
An identifier reference to a snippet to use in the setup phase of an API check in this group. |
|
Tear Down Snippet ID
|
tearDownSnippetId | number |
An identifier reference to a snippet to use in the teardown phase of an API check in this group. |
|
Local Setup Script
|
localSetupScript | string |
A valid piece of Node.js code to run in the setup phase of an API check in this group. |
|
Local Tear Down Script
|
localTearDownScript | string |
A valid piece of Node.js code to run in the teardown phase of an API check in this group. |
|
Check Private Locations
|
privateLocations | array of string |
An array of one or more private locations where to run the checks. |
Returns
- Body
- CheckGroup
Updates a dashboard. Will return a 409 when attempting to create a dashboard with a custom URL or custom domain that is already taken.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
dashboardId | True | string |
The dashboard identifier. |
Custom URL
|
customUrl | string |
A subdomain name under checklyhq.com. Needs to be unique across all users. |
|
Custom Domain
|
customDomain | string |
A custom user domain, e.g. status.example.com. See the docs on updating your DNS and SSL usage. |
|
Logo
|
logo | string |
A URL pointing to an image file. |
|
Favicon
|
favicon | string |
A URL pointing to an image file used as dashboard favicon. |
|
Link
|
link | string |
A URL link to redirect when dashboard logo is clicked on. |
|
Header
|
header | string |
A piece of text displayed at the top of your dashboard. |
|
Description
|
description | string |
A piece of text displayed below the header or title of your dashboard. |
|
Width
|
width | string |
Determines whether to use the full screen or focus in the center. |
|
Refresh Rate
|
refreshRate | number |
How often to refresh the dashboard in seconds. |
|
Paginate
|
paginate | boolean |
Determines of pagination is on or off. |
|
Pagination Rate
|
paginationRate | number |
How often to trigger pagination in seconds. |
|
Checks per Page
|
checksPerPage | number |
Number of checks displayed per page. |
|
Use And Operator
|
useTagsAndOperator | boolean |
When to use AND operator for tags lookup. |
|
Hide Tags
|
hideTags | boolean |
Show or hide the tags on the dashboard. |
|
Dashboard Tag List
|
tags | array of string |
A list of one or more tags that filter which checks to display on the dashboard. |
Returns
- Body
- Dashboard
Updates an environment variable. Uses the key field as the identifier for updating. Only updates value and locked property.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Key
|
key | True | string |
The key. |
Key
|
key | string |
The key of the environment variable (this value cannot be changed). |
|
Value
|
value | True | string |
The value of the environment variable. |
Locked
|
locked | boolean |
Used only in the UI to hide the value like a password. |
Returns
- Body
- EnvironmentVariable
Updates a maintenance window.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
id | True | integer |
The identifier. |
Name
|
name | True | string |
The maintenance window name. |
Maintenance Window Tag List
|
tags | array of string |
The names of the checks and groups maintenance window should apply to. |
|
Starts At
|
startsAt | True | date |
The start date of the maintenance window. |
Ends At
|
endsAt | True | date |
The end date of the maintenance window. |
Repeat Interval
|
repeatInterval | number |
The repeat interval of the maintenance window from the first occurrence. |
|
Repeat Unit
|
repeatUnit | True | string |
The repeat strategy for the maintenance window. |
Repeat Ends At
|
repeatEndsAt | date |
The end date where the maintenance window should stop repeating. |
Returns
- Body
- MaintenanceWindow
Updates a private location.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
id | True | string |
The identifier. |
Name
|
name | True | string |
The name assigned to the private location. |
Icon
|
icon | string |
The icon. |
Returns
Updates a snippet.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
id | True | integer |
The identifier. |
Name
|
name | True | string |
The snippet name. |
Script
|
script | True | string |
Your Node.js code that interacts with the API check lifecycle, or functions as a partial for browser checks. |
Returns
- Body
- Snippet
Update an alert channel.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
id | True | integer |
The identifier. |
ID
|
id | number |
The identifier. |
|
Check ID
|
checkId | guid |
The check identifier. |
|
Group ID
|
groupId | number |
The group identifier. |
|
Activated
|
activated | True | boolean |
Whether activated. |
Type
|
type | True | string |
The type. |
Alert Channel Create Config
|
config | True | object |
The alert channel create config. |
Send Recovery
|
sendRecovery | boolean |
Whether send recovery. |
|
Send Failure
|
sendFailure | boolean |
Whether send failure. |
|
Send Degraded
|
sendDegraded | boolean |
Whether send degraded. |
|
SSL Expiry
|
sslExpiry | boolean |
Determines if an alert should be send for expiring SSL certificates. |
|
SSL Expiry Threshold
|
sslExpiryThreshold | integer |
At what moment in time to start alerting on SSL certificates. |
Returns
- Body
- AlertChannel
Updates an API check.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
id | True | string |
The identifier. |
Auto-assign Alerts
|
autoAssignAlerts | boolean |
Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created. |
|
Name
|
name | string |
The name of the check. |
|
Activated
|
activated | boolean |
Determines if the check is running or not. |
|
Muted
|
muted | boolean |
Determines if any notifications will be send out when a check fails and/or recovers. |
|
Double Check
|
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. |
|
Should Fail
|
shouldFail | boolean |
Allows to invert the behavior of when a check is considered to fail. Allows for validating error status like 404. |
|
Check Location List
|
locations | array of string |
An array of one or more data center locations where to run this check. |
|
Check Tag List
|
tags | array of string |
Tags for organizing and filtering checks. |
|
Escalation Type
|
escalationType | string |
Determines what type of escalation to use. |
|
Failed Run Threshold
|
failedRunThreshold | number |
After how many failed consecutive check runs an alert notification should be send. |
|
Minutes Failing Threshold
|
minutesFailingThreshold | number |
After how many minutes after a check starts failing an alert should be send. |
|
Amount
|
amount | number |
How many reminders to send out after the initial alert notification. |
|
Interval
|
interval | number |
At what interval the reminders should be send. |
|
Enabled
|
enabled | boolean |
Determines if alert notifications should be send for expiring SSL certificates. |
|
Alert Threshold
|
alertThreshold | integer |
At what moment in time to start alerting on SSL certificates. |
|
Use Global Alert Settings
|
useGlobalAlertSettings | boolean |
When true, the account level alert setting will be used, not the alert setting defined on this check. |
|
Group ID
|
groupId | number |
The identifier of the check group this check is part of. |
|
Group Order
|
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. |
|
Runtime ID
|
runtimeId | string |
The runtime version, i.e. fixed set of runtime dependencies, used to execute this check. |
|
Alert Channel ID
|
alertChannelId | True | number |
The alert channel identifier. |
Activated
|
activated | True | boolean |
Whether activated. |
method
|
method | True | string | |
URL
|
url | True | string |
The URL address. |
Follow redirects
|
followRedirects | boolean |
Whether to follow redirects. |
|
Skip SSL
|
skipSSL | boolean |
Whether to skip SSL. |
|
Body
|
body | string |
The body. |
|
Body Type
|
bodyType | string |
The body type. |
|
Key
|
key | True | string |
The key. |
Value
|
value | True | string |
The value. |
Locked
|
locked | boolean |
Whether locked. |
|
Source
|
source | string |
The source. |
|
Property
|
property | string |
The property. |
|
Comparison
|
comparison | string |
The comparison. |
|
Target
|
target | string |
The target. |
|
Username
|
username | True | string |
The username. |
Password
|
password | True | string |
The password. |
Frequency
|
frequency | integer |
How often the check should run in minutes. |
|
Tear Down Snippet ID
|
tearDownSnippetId | number |
An identifier reference to a snippet to use in the teardown phase of an API check. |
|
Setup Snippet ID
|
setupSnippetId | number |
An identifier reference to a snippet to use in the setup phase of an API check. |
|
Frequency Offset
|
frequencyOffset | integer |
Used for setting seconds for check frequencies under 1 minutes and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula Math.floor(frequency * 10), i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula Math.ceil(frequency / 60), i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. |
|
Local Setup Script
|
localSetupScript | string |
A valid piece of Node.js code to run in the setup phase. |
|
Local Tear Down Script
|
localTearDownScript | string |
A valid piece of Node.js code to run in the teardown phase. |
|
Degraded Response Time
|
degradedResponseTime | number |
The response time in milliseconds where a check should be considered degraded. |
|
Max Response Time
|
maxResponseTime | number |
The response time in milliseconds where a check should be considered failing. |
|
Private Locations
|
privateLocations | array of string |
An array of one or more private locations where to run the check. |
Returns
- Body
- CheckAPI
Update the subscriptions of an alert channel. Use this to add a check to an alert channel so failure and recovery alerts are send out for that check. Note: when passing the subscription object, you can only specify a checkId or a groupId, not both.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
id | True | integer |
The identifier. |
Check ID
|
checkId | guid |
You can either pass a checkId or a groupId, but not both. |
|
Group ID
|
groupId | number |
You can either pass a checkId or a groupId, but not both. |
|
Activated
|
activated | True | boolean |
Whether activated. |
Returns
The configuration of the alert channel.
Name | Path | Type | Description |
---|---|---|---|
Alert Channel Config
|
object |
The configuration of the alert channel. |
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | number |
The identifier. |
Check ID
|
checkId | guid |
The check identifier. |
Group ID
|
groupId | number |
The group identifier. |
Activated
|
activated | boolean |
Whether activated. |
All checks subscribed to this channel.
Name | Path | Type | Description |
---|---|---|---|
Items
|
AlertChanelSubscription |
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | number |
The identifier. |
Type
|
type | string |
The type of alert channel, i.e. EMAIL or SLACK. |
Alert Channel Config
|
config | AlertChannelConfig |
The configuration of the alert channel. |
Alert Channel Subscription List
|
subscriptions | AlertChanelSubscriptionList |
All checks subscribed to this channel. |
Send Recovery
|
sendRecovery | boolean |
Whether send recovery. |
Send Failure
|
sendFailure | boolean |
Whether send failure. |
Send Degraded
|
sendDegraded | boolean |
Whether send degraded. |
SSL Expiry
|
sslExpiry | boolean |
Determines if an alert should be send for expiring SSL certificates. |
SSL Expiry Threshold
|
sslExpiryThreshold | integer |
At what moment in time to start alerting on SSL certificates. |
Created At
|
created_at | date-time |
When created at. |
Updated At
|
updated_at | date-time |
When updated at. |
Name | Path | Type | Description |
---|---|---|---|
Items
|
AlertChannel |
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
The unique identifier of this alert. |
Name
|
name | string |
The name of the check. |
Check ID
|
checkId | string |
The identifier of check this alert belongs to. |
Alert Type
|
alertType | string |
The type of alert. |
Check Type
|
checkType | string |
The type of the check. |
Run Location
|
runLocation | string |
What data center location this check alert was triggered from. |
Response Time
|
responseTime | number |
Describes the time it took to execute relevant parts of this check. Any setup timer system time needed to start executing this check in the Checkly backend is not part of this. |
Error
|
error | string |
Any specific error messages that were part of the failing check triggering the alert. |
Status Code
|
statusCode | string |
The status code of the response. Only applies to API checks. |
Created At
|
created_at | date |
The date and time this check alert was created. |
Started At
|
startedAt | date |
The date and time this check alert was started. |
Name | Path | Type | Description |
---|---|---|---|
Items
|
CheckAlert |
Tags for organizing and filtering checks.
Name | Path | Type | Description |
---|---|---|---|
Items
|
string |
An array of one or more data center locations where to run the checks.
Name | Path | Type | Description |
---|---|---|---|
Items
|
string |
Name | Path | Type | Description |
---|---|---|---|
Key
|
key | string |
The key. |
Value
|
value | string |
The value. |
Locked
|
locked | boolean |
Whether locked. |
Name | Path | Type | Description |
---|---|---|---|
Items
|
KeyValue |
Name | Path | Type | Description |
---|---|---|---|
Items
|
KeyValue |
Name | Path | Type | Description |
---|---|---|---|
Source
|
source | string |
The source. |
Property
|
property | string |
The property. |
Comparison
|
comparison | string |
The comparison. |
Target
|
target | string |
The target. |
Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the property field.
Name | Path | Type | Description |
---|---|---|---|
Items
|
Assertion |
Name | Path | Type | Description |
---|---|---|---|
Username
|
username | string |
The username. |
Password
|
password | string |
The password. |
Name | Path | Type | Description |
---|---|---|---|
URL
|
url | string |
The base URL for this group which you can reference with the {{GROUP_BASE_URL}} variable in all group checks. |
headers
|
headers | HeaderList | |
queryParameters
|
queryParameters | QueryParameterList | |
Assertion List
|
assertions | AssertionList |
Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the property field. |
basicAuth
|
basicAuth | BasicAuth |
The check group browser check defaults.
Name | Path | Type | Description |
---|---|---|---|
Check Group Browser Check Defaults
|
object |
The check group browser check defaults. |
Name | Path | Type | Description |
---|---|---|---|
Key
|
key | string |
The key of the environment variable (this value cannot be changed). |
Value
|
value | string |
The value of the environment variable. |
Locked
|
locked | boolean |
Used only in the UI to hide the value like a password. |
Name | Path | Type | Description |
---|---|---|---|
Items
|
EnvironmentVariable |
Name | Path | Type | Description |
---|---|---|---|
Failed Run Threshold
|
failedRunThreshold | number |
After how many failed consecutive check runs an alert notification should be send. |
Name | Path | Type | Description |
---|---|---|---|
Minutes Failing Threshold
|
minutesFailingThreshold | number |
After how many minutes after a check starts failing an alert should be send. |
Name | Path | Type | Description |
---|---|---|---|
Amount
|
amount | number |
How many reminders to send out after the initial alert notification. |
Interval
|
interval | number |
At what interval the reminders should be send. |
[DEPRECATED] sslCertificates
is deprecated and is not longer used. Please ignore it, will be removed in a future version.
Name | Path | Type | Description |
---|---|---|---|
Enabled
|
enabled | boolean |
Determines if alert notifications should be send for expiring SSL certificates. |
Alert Threshold
|
alertThreshold | integer |
At what moment in time to start alerting on SSL certificates. |
Alert settings.
Name | Path | Type | Description |
---|---|---|---|
Escalation Type
|
escalationType | string |
Determines what type of escalation to use. |
runBasedEscalation
|
runBasedEscalation | AlertSettingsRunBasedEscalation | |
timeBasedEscalation
|
timeBasedEscalation | AlertSettingsTimeBasedEscalation | |
reminders
|
reminders | AlertSettingsReminders | |
Alert Settings SSL Certificates
|
sslCertificates | AlertSettingsSSLCertificates |
[DEPRECATED] |
Alert channel subscription.
Name | Path | Type | Description |
---|---|---|---|
Alert Channel ID
|
alertChannelId | number |
The alert channel identifier. |
Activated
|
activated | boolean |
Whether activated. |
List of alert channel subscriptions.
Name | Path | Type | Description |
---|---|---|---|
Alert Channel Subscription
|
Model1 |
Alert channel subscription. |
An array of one or more private locations where to run the check.
Name | Path | Type | Description |
---|---|---|---|
Items
|
string |
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | number |
The identifier. |
Name
|
name | string |
The name of the check group. |
Activated
|
activated | boolean |
Determines if the checks in the group are running or not. |
Muted
|
muted | boolean |
Determines if any notifications will be send out when a check in this group fails and/or recovers. |
Check Group Tag List
|
tags | CheckGroupTagList |
Tags for organizing and filtering checks. |
Check Group Location List
|
locations | CheckGroupLocationList |
An array of one or more data center locations where to run the checks. |
Concurrency
|
concurrency | number |
Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API. |
apiCheckDefaults
|
apiCheckDefaults | CheckGroupAPICheckDefaults | |
Check Group Browser Check Defaults
|
browserCheckDefaults | CheckGroupBrowserCheckDefaults |
The check group browser check defaults. |
environmentVariables
|
environmentVariables | EnvironmentVariableList | |
Double Check
|
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. |
Use Global Alert Settings
|
useGlobalAlertSettings | boolean |
When true, the account level alert setting will be used, not the alert setting defined on this check group. |
Check Group Alert Settings
|
alertSettings | CheckGroupAlertSettings |
Alert settings. |
Alert Channel Subscription Create List
|
alertChannelSubscriptions | AlertChannelSubscriptionCreateList |
List of alert channel subscriptions. |
Setup Snippet ID
|
setupSnippetId | number |
An identifier reference to a snippet to use in the setup phase of an API check in this group. |
Tear Down Snippet ID
|
tearDownSnippetId | number |
An identifier reference to a snippet to use in the teardown phase of an API check in this group. |
Local Setup Script
|
localSetupScript | string |
A valid piece of Node.js code to run in the setup phase of an API check in this group. |
Local Tear Down Script
|
localTearDownScript | string |
A valid piece of Node.js code to run in the teardown phase of an API check in this group. |
Runtime ID
|
runtimeId | string |
The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group. |
Private Locations
|
privateLocations | privateLocations |
An array of one or more private locations where to run the check. |
Created At
|
created_at | date |
When created at. |
Updated At
|
updated_at | date-time |
When updated at. |
Name | Path | Type | Description |
---|---|---|---|
Items
|
CheckGroup |
An array of one or more data center locations where to run this check.
Name | Path | Type | Description |
---|---|---|---|
Items
|
string |
Tags for organizing and filtering checks.
Name | Path | Type | Description |
---|---|---|---|
Items
|
string |
Alert settings.
Name | Path | Type | Description |
---|---|---|---|
Escalation Type
|
escalationType | string |
Determines what type of escalation to use. |
runBasedEscalation
|
runBasedEscalation | AlertSettingsRunBasedEscalation | |
timeBasedEscalation
|
timeBasedEscalation | AlertSettingsTimeBasedEscalation | |
reminders
|
reminders | AlertSettingsReminders | |
Alert Settings SSL Certificates
|
sslCertificates | AlertSettingsSSLCertificates |
[DEPRECATED] |
Name | Path | Type | Description |
---|---|---|---|
Alert Channel ID
|
alertChannelId | number |
The alert channel identifier. |
Activated
|
activated | boolean |
Whether activated. |
Name | Path | Type | Description |
---|---|---|---|
Items
|
CheckAlertChannelSubscription |
The check request.
Name | Path | Type | Description |
---|---|---|---|
Check Request
|
object |
The check request. |
Key/value pairs for setting environment variables during check execution. These are only relevant for Browser checks. Use global environment variables whenever possible.
Name | Path | Type | Description |
---|---|---|---|
Items
|
EnvironmentVariable |
Name | Path | Type | Description |
---|---|---|---|
Address
|
address | string |
The address. |
Name | Path | Type | Description |
---|---|---|---|
Items
|
CheckAlertEmail |
Name | Path | Type | Description |
---|---|---|---|
Items
|
KeyValue |
Name | Path | Type | Description |
---|---|---|---|
Items
|
KeyValue |
Name | Path | Type | Description |
---|---|---|---|
Name
|
name | string |
The name. |
URL
|
url | string |
The URL address. |
Method
|
method | string |
The method. |
headers
|
headers | Model4 | |
queryParameters
|
queryParameters | Model5 |
Name | Path | Type | Description |
---|---|---|---|
Items
|
CheckAlertWebhook |
Name | Path | Type | Description |
---|---|---|---|
URL
|
url | string |
The URL address. |
Name | Path | Type | Description |
---|---|---|---|
Items
|
CheckAlertSlack |
Name | Path | Type | Description |
---|---|---|---|
Number
|
number | string |
The number. |
Name
|
name | string |
The name. |
Name | Path | Type | Description |
---|---|---|---|
Items
|
CheckAlertSMS |
Name | Path | Type | Description |
---|---|---|---|
email
|
CheckAlertEmailList | ||
webhook
|
webhook | CheckAlertWebhookList | |
slack
|
slack | CheckAlertSlackList | |
sms
|
sms | CheckAlertSMSList |
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
The identifier. |
Name
|
name | string |
The name of the check. |
Activated
|
activated | boolean |
Determines if the check is running or not. |
Muted
|
muted | boolean |
Determines if any notifications will be send out when a check fails and/or recovers. |
Double Check
|
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. |
Should Fail
|
shouldFail | boolean |
Allows to invert the behavior of when a check is considered to fail. Allows for validating error status like 404. |
Check Location List
|
locations | CheckLocationList |
An array of one or more data center locations where to run this check. |
Check Tag List
|
tags | CheckTagList |
Tags for organizing and filtering checks. |
Check Alert Settings
|
alertSettings | CheckAlertSettings |
Alert settings. |
Use Global Alert Settings
|
useGlobalAlertSettings | boolean |
When true, the account level alert setting will be used, not the alert setting defined on this check. |
Group ID
|
groupId | number |
The identifier of the check group this check is part of. |
Group Order
|
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. |
Runtime ID
|
runtimeId | string |
The runtime version, i.e. fixed set of runtime dependencies, used to execute this check. |
alertChannelSubscriptions
|
alertChannelSubscriptions | CheckAlertChannelSubscriptionList | |
Check Type
|
checkType | string |
The type of the check. |
Frequency
|
frequency | integer |
How often the check should run in minutes. |
Frequency Offset
|
frequencyOffset | integer |
The frequency offset. |
Check Request
|
request | CheckRequest |
The check request. |
Script
|
script | string |
The script. |
Check Environment Variable List
|
environmentVariables | CheckEnvironmentVariableList |
Key/value pairs for setting environment variables during check execution. These are only relevant for Browser checks. Use global environment variables whenever possible. |
Setup Snippet ID
|
setupSnippetId | number |
An identifier reference to a snippet to use in the setup phase of an API check. |
Tear Down Snippet ID
|
tearDownSnippetId | number |
An identifier reference to a snippet to use in the teardown phase of an API check. |
Local Setup Script
|
localSetupScript | string |
A valid piece of Node.js code to run in the setup phase. |
Local Tear Down Script
|
localTearDownScript | string |
A valid piece of Node.js code to run in the teardown phase. |
Degraded Response Time
|
degradedResponseTime | number |
The response time in milliseconds where a check should be considered degraded. |
Max Response Time
|
maxResponseTime | number |
The response time in milliseconds where a check should be considered failing. |
alertChannels
|
alertChannels | CheckAlertChannels | |
Private Locations
|
privateLocations | privateLocations |
An array of one or more private locations where to run the check. |
Created At
|
created_at | date |
When created at. |
Updated At
|
updated_at | date-time |
When updated at. |
Name | Path | Type | Description |
---|---|---|---|
Items
|
CheckGroupCheck |
List of API check assertions.
Name | Path | Type | Description |
---|---|---|---|
Items
|
string |
The headers.
Name | Path | Type | Description |
---|---|---|---|
Headers
|
object |
The headers. |
The parameters.
Name | Path | Type | Description |
---|---|---|---|
Params
|
object |
The parameters. |
The request for the API.
Name | Path | Type | Description |
---|---|---|---|
method
|
method | string | |
url
|
url | string | |
data
|
data | string | |
Headers
|
headers | headers |
The headers. |
Params
|
params | params |
The parameters. |
The timings.
Name | Path | Type | Description |
---|---|---|---|
Timings
|
object |
The timings. |
The timing phases.
Name | Path | Type | Description |
---|---|---|---|
Timing Phases
|
object |
The timing phases. |
The API response.
Name | Path | Type | Description |
---|---|---|---|
Status
|
status | number |
The status. |
Status Text
|
statusText | string |
The status text. |
Body
|
body | string |
The body. |
Headers
|
headers | headers |
The headers. |
Timings
|
timings | timings |
The timings. |
Timing Phases
|
timingPhases | timingPhases |
The timing phases. |
The job log.
Name | Path | Type | Description |
---|---|---|---|
Job Log
|
object |
The job log. |
Assets generated from the check run.
Name | Path | Type | Description |
---|---|---|---|
Items
|
string |
The response data for an API check.
Name | Path | Type | Description |
---|---|---|---|
Assertions
|
assertions | assertions |
List of API check assertions. |
Request
|
request | request |
The request for the API. |
Response
|
response | response |
The API response. |
Request Error
|
requestError | string |
Describes if an error occurred on the request. |
Job Log
|
jobLog | jobLog |
The job log. |
Job Assets
|
jobAssets | jobAssets |
Assets generated from the check run. |
List of errors on the check run.
Name | Path | Type | Description |
---|---|---|---|
Items
|
string |
Check run log results.
Name | Path | Type | Description |
---|---|---|---|
Items
|
string |
The trace summary.
Name | Path | Type | Description |
---|---|---|---|
Trace Summary
|
object |
The trace summary. |
List of pages used on the check run.
Name | Path | Type | Description |
---|---|---|---|
Items
|
string |
The response data for a browser check.
Name | Path | Type | Description |
---|---|---|---|
Type
|
type | string |
The type of framework the check is using. |
Errors
|
errors | errors |
List of errors on the check run. |
End Time
|
endTime | number |
End time of the check run. |
Start Time
|
startTime | number |
Start time of the check run. |
Runtime Version
|
runtimeVersion | string |
Active runtime version. |
Check Run Log
|
jobLog | Model9 |
Check run log results. |
Job Assets
|
jobAssets | jobAssets |
Assets generated from the check run. |
Trace Summary
|
traceSummary | traceSummary |
The trace summary. |
Pages
|
pages | pages |
List of pages used on the check run. |
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
The unique identifier of this result. |
Name
|
name | string |
The name of the check. |
Check ID
|
checkId | string |
The identifier of the check. |
Has Failures
|
hasFailures | boolean |
Describes if any failure has occurred during this check run. This is should be your main focus for assessing API or browser check behavior. Assertions that fail, timeouts or failing scripts all resolve to this value being true. |
Has Errors
|
hasErrors | boolean |
Describes if an internal error has occurred in Checkly's backend. This should be false in almost all cases. |
Is Degraded
|
isDegraded | boolean |
A check is degraded if it is over the degradation limit set by the degradedResponseTime field on the check. Applies only to API checks. |
Over Max Response Time
|
overMaxResponseTime | boolean |
Set to true if the response time is over the limit set by the maxResponseTime field on the check. Applies only to API checks. |
Run Location
|
runLocation | string |
What data center location this check result originated from. |
Started At
|
startedAt | date-time |
The started at time. |
Stopped At
|
stoppedAt | date-time |
The stopped at time. |
Created At
|
created_at | date-time |
When created at. |
Response Time
|
responseTime | number |
Describes the time it took to execute relevant parts of this check. Any setup timer system time needed to start executing this check in the Checkly backend is not part of this. |
Check Result API
|
apiCheckResult | CheckResultAPI |
The response data for an API check. |
Browser Check Result
|
browserCheckResult | CheckResultBrowser |
The response data for a browser check. |
Check Run ID
|
checkRunId | number |
The identifier of the specific check run that created this check result. |
Attempts
|
attempts | number |
How often this check was retried. This will be larger than 0 when double checking is enabled. |
Name | Path | Type | Description |
---|---|---|---|
Items
|
CheckResult |
Name | Path | Type | Description |
---|---|---|---|
Name
|
name | string |
The name of the check. |
Check ID
|
checkId | string |
The identifier of check this status belongs to. |
Has Failures
|
hasFailures | boolean |
Describes if this check is currently failing. If any of the assertions for an API check-fail this value is true. If a browser check fails for whatever reason, this is true. |
Has Errors
|
hasErrors | boolean |
Describes if due to some error outside of normal operation this check is failing. This should be extremely rare and only when there is an error in the Checkly backend. |
Is Degraded
|
isDegraded | boolean |
A check is degraded if it is over the degradation limit set by the degradedResponseTime field on the check. Applies only to API checks. |
Longest Run
|
longestRun | number |
The longest ever recorded response time for this check. |
Shortest Run
|
shortestRun | number |
The shortest ever recorded response time for this check. |
Last Run Location
|
lastRunLocation | string |
What location this check was last run at. |
Last Check Run ID
|
lastCheckRunId | string |
The unique incrementing identifier for each check run. |
SSL Days Remaining
|
sslDaysRemaining | number |
How many days remain till the current SSL certificate expires. |
Created At
|
created_at | date |
When created at. |
Updated At
|
updated_at | date-time |
When updated at. |
Name | Path | Type | Description |
---|---|---|---|
Items
|
CheckStatus |
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
The identifier. |
Name
|
name | string |
The name of the check. |
Activated
|
activated | boolean |
Determines if the check is running or not. |
Muted
|
muted | boolean |
Determines if any notifications will be send out when a check fails and/or recovers. |
Double Check
|
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. |
Should Fail
|
shouldFail | boolean |
Allows to invert the behavior of when a check is considered to fail. Allows for validating error status like 404. |
Check Location List
|
locations | CheckLocationList |
An array of one or more data center locations where to run this check. |
Check Tag List
|
tags | CheckTagList |
Tags for organizing and filtering checks. |
Check Alert Settings
|
alertSettings | CheckAlertSettings |
Alert settings. |
Use Global Alert Settings
|
useGlobalAlertSettings | boolean |
When true, the account level alert setting will be used, not the alert setting defined on this check. |
Group ID
|
groupId | number |
The identifier of the check group this check is part of. |
Group Order
|
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. |
Runtime ID
|
runtimeId | string |
The runtime version, i.e. fixed set of runtime dependencies, used to execute this check. |
alertChannelSubscriptions
|
alertChannelSubscriptions | CheckAlertChannelSubscriptionList | |
Check Type
|
checkType | string |
The type of the check. |
Frequency
|
frequency | integer |
How often the check should run in minutes. |
Frequency Offset
|
frequencyOffset | integer |
The frequency offset. |
Check Request
|
request | CheckRequest |
The check request. |
Script
|
script | string |
The script. |
Check Environment Variable List
|
environmentVariables | CheckEnvironmentVariableList |
Key/value pairs for setting environment variables during check execution. These are only relevant for Browser checks. Use global environment variables whenever possible. |
Setup Snippet ID
|
setupSnippetId | number |
An identifier reference to a snippet to use in the setup phase of an API check. |
Tear Down Snippet ID
|
tearDownSnippetId | number |
An identifier reference to a snippet to use in the teardown phase of an API check. |
Local Setup Script
|
localSetupScript | string |
A valid piece of Node.js code to run in the setup phase. |
Local Tear Down Script
|
localTearDownScript | string |
A valid piece of Node.js code to run in the teardown phase. |
Degraded Response Time
|
degradedResponseTime | number |
The response time in milliseconds where a check should be considered degraded. |
Max Response Time
|
maxResponseTime | number |
The response time in milliseconds where a check should be considered failing. |
alertChannels
|
alertChannels | CheckAlertChannels | |
Private Locations
|
privateLocations | privateLocations |
An array of one or more private locations where to run the check. |
Created At
|
created_at | date |
When created at. |
Updated At
|
updated_at | date-time |
When updated at. |
Name | Path | Type | Description |
---|---|---|---|
Items
|
Check |
Name | Path | Type | Description |
---|---|---|---|
Items
|
KeyValue |
Name | Path | Type | Description |
---|---|---|---|
Items
|
KeyValue |
Determines the request that the check is going to run.
Name | Path | Type | Description |
---|---|---|---|
method
|
method | string | |
URL
|
url | string |
The URL address. |
Follow redirects
|
followRedirects | boolean |
Whether to follow redirects. |
Skip SSL
|
skipSSL | boolean |
Whether to skip SSL. |
Body
|
body | string |
The body. |
Body Type
|
bodyType | string |
The body type. |
headers
|
headers | Model14 | |
queryParameters
|
queryParameters | Model15 | |
Assertion List
|
assertions | AssertionList |
Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the property field. |
basicAuth
|
basicAuth | BasicAuth |
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
The identifier. |
Name
|
name | string |
The name of the check. |
Activated
|
activated | boolean |
Determines if the check is running or not. |
Muted
|
muted | boolean |
Determines if any notifications will be send out when a check fails and/or recovers. |
Double Check
|
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. |
Should Fail
|
shouldFail | boolean |
Allows to invert the behavior of when a check is considered to fail. Allows for validating error status like 404. |
Check Location List
|
locations | CheckLocationList |
An array of one or more data center locations where to run this check. |
Check Tag List
|
tags | CheckTagList |
Tags for organizing and filtering checks. |
Check Alert Settings
|
alertSettings | CheckAlertSettings |
Alert settings. |
Use Global Alert Settings
|
useGlobalAlertSettings | boolean |
When true, the account level alert setting will be used, not the alert setting defined on this check. |
Group ID
|
groupId | number |
The identifier of the check group this check is part of. |
Group Order
|
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. |
Runtime ID
|
runtimeId | string |
The runtime version, i.e. fixed set of runtime dependencies, used to execute this check. |
alertChannelSubscriptions
|
alertChannelSubscriptions | CheckAlertChannelSubscriptionList | |
Check Request
|
request | Model16 |
Determines the request that the check is going to run. |
Frequency
|
frequency | integer |
How often the check should run in minutes. |
Frequency Offset
|
frequencyOffset | integer |
Used for setting seconds for check frequencies under 1 minutes (only for API checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula Math.floor(frequency * 10), i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula Math.ceil(frequency / 60), i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. |
Tear Down Snippet ID
|
tearDownSnippetId | number |
An identifier reference to a snippet to use in the teardown phase of an API check. |
Setup Snippet ID
|
setupSnippetId | number |
An identifier reference to a snippet to use in the setup phase of an API check. |
Local Setup Script
|
localSetupScript | string |
A valid piece of Node.js code to run in the setup phase. |
Local Tear Down Script
|
localTearDownScript | string |
A valid piece of Node.js code to run in the teardown phase. |
Degraded Response Time
|
degradedResponseTime | number |
The response time in milliseconds where a check should be considered degraded. |
Max Response Time
|
maxResponseTime | number |
The response time in milliseconds where a check should be considered failing. |
Private Locations
|
privateLocations | privateLocations |
An array of one or more private locations where to run the check. |
Check Type
|
checkType | string |
The check type. |
alertChannels
|
alertChannels | CheckAlertChannels | |
Created At
|
created_at | date |
When created at. |
Updated At
|
updated_at | date-time |
When updated at. |
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
The identifier. |
Name
|
name | string |
The name of the check. |
Activated
|
activated | boolean |
Determines if the check is running or not. |
Muted
|
muted | boolean |
Determines if any notifications will be send out when a check fails and/or recovers. |
Double Check
|
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. |
Should Fail
|
shouldFail | boolean |
Allows to invert the behavior of when a check is considered to fail. Allows for validating error status like 404. |
Check Location List
|
locations | CheckLocationList |
An array of one or more data center locations where to run this check. |
Check Tag List
|
tags | CheckTagList |
Tags for organizing and filtering checks. |
Check Alert Settings
|
alertSettings | CheckAlertSettings |
Alert settings. |
Use Global Alert Settings
|
useGlobalAlertSettings | boolean |
When true, the account level alert setting will be used, not the alert setting defined on this check. |
Group ID
|
groupId | number |
The identifier of the check group this check is part of. |
Group Order
|
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. |
Runtime ID
|
runtimeId | string |
The runtime version, i.e. fixed set of runtime dependencies, used to execute this check. |
alertChannelSubscriptions
|
alertChannelSubscriptions | CheckAlertChannelSubscriptionList | |
Check Type
|
checkType | string |
The check type. |
Frequency
|
frequency | integer |
How often the check should run in minutes. |
Script
|
script | string |
A valid piece of Node.js javascript code describing a browser interaction with the Puppeteer or Playwright frameworks. |
Private Locations
|
privateLocations | privateLocations |
An array of one or more private locations where to run the check. |
alertChannels
|
alertChannels | CheckAlertChannels | |
Created At
|
created_at | date |
When created at. |
Updated At
|
updated_at | date-time |
When updated at. |
A list of one or more tags that filter which checks to display on the dashboard.
Name | Path | Type | Description |
---|---|---|---|
Items
|
string |
Name | Path | Type | Description |
---|---|---|---|
Custom Domain
|
customDomain | string |
A custom user domain, e.g. status.example.com. See the docs on updating your DNS and SSL usage. |
Custom URL
|
customUrl | string |
A subdomain name under checklyhq.com. Needs to be unique across all users. |
Logo
|
logo | string |
A URL pointing to an image file. |
Favicon
|
favicon | string |
A URL pointing to an image file used as dashboard favicon. |
Link
|
link | string |
A URL link to redirect when dashboard logo is clicked on. |
Header
|
header | string |
A piece of text displayed at the top of your dashboard. |
Description
|
description | string |
A piece of text displayed below the header or title of your dashboard. |
Width
|
width | string |
Determines whether to use the full screen or focus in the center. |
Refresh Rate
|
refreshRate | number |
How often to refresh the dashboard in seconds. |
Paginate
|
paginate | boolean |
Determines of pagination is on or off. |
Pagination Rate
|
paginationRate | number |
How often to trigger pagination in seconds. |
Checks per Page
|
checksPerPage | number |
Number of checks displayed per page. |
Use And Operator
|
useTagsAndOperator | boolean |
When to use AND operator for tags lookup. |
Hide Tags
|
hideTags | boolean |
Show or hide the tags on the dashboard. |
Dashboard Tag List
|
tags | DashboardTagList |
A list of one or more tags that filter which checks to display on the dashboard. |
Dashboard ID
|
dashboardId | string |
The dashboard identifier. |
Name | Path | Type | Description |
---|---|---|---|
Items
|
Dashboard |
Name | Path | Type | Description |
---|---|---|---|
Region
|
region | string |
The unique identifier of this location. |
Name
|
name | string |
Friendly name of this location. |
Name | Path | Type | Description |
---|---|---|---|
Items
|
Location |
The names of the checks and groups maintenance window should apply to.
Name | Path | Type | Description |
---|---|---|---|
Items
|
string |
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | number |
The identifier of the maintenance window. |
Name
|
name | string |
The maintenance window name. |
Maintenance Window Tag List
|
tags | MaintenanceWindowTagList |
The names of the checks and groups maintenance window should apply to. |
Starts At
|
startsAt | date |
The start date of the maintenance window. |
Ends At
|
endsAt | date |
The end date of the maintenance window. |
Repeat Interval
|
repeatInterval | number |
The repeat interval of the maintenance window from the first occurrence. |
Repeat Unit
|
repeatUnit | string |
The repeat strategy for the maintenance window. |
Repeat Ends At
|
repeatEndsAt | date |
The end date where the maintenance window should stop repeating. |
Created At
|
created_at | date |
The creation date of the maintenance window. |
Updated At
|
updated_at | date |
The last date that the maintenance window was updated. |
The maintenance window list.
Name | Path | Type | Description |
---|---|---|---|
Items
|
MaintenanceWindow |
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | guid |
The identifier. |
Check ID
|
checkId | guid |
The identifier of the check. |
Private Location ID
|
privateLocationId | guid |
The identifier of the assigned private location. |
The check this private location has assigned.
Name | Path | Type | Description |
---|---|---|---|
Items
|
CheckAssignment |
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | guid |
The identifier. |
Group ID
|
groupId | number |
The identifier of the group. |
Private Location ID
|
privateLocationId | guid |
The identifier of the assigned private location. |
The group this private location has assigned.
Name | Path | Type | Description |
---|---|---|---|
Items
|
GroupAssignment |
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | guid |
The identifier. |
Raw Key
|
rawKey | string |
The raw key. |
Masked Key
|
maskedKey | string |
The masked key value. |
Created At
|
created_at | date |
When created at. |
Updated At
|
updated_at | date |
When updated at. |
Name | Path | Type | Description |
---|---|---|---|
Items
|
privateLocationKeys |
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | guid |
The identifier. |
Name
|
name | string |
The name assigned to the private location. |
Slug Name
|
slugName | string |
Valid slug name. |
Icon
|
icon | string |
The private location icon. |
Created At
|
created_at | date |
When created at. |
Updated At
|
updated_at | date |
When updated at. |
Check Assignments
|
checkAssignments | checkAssignments |
The check this private location has assigned. |
Group Assignments
|
groupAssignments | groupAssignments |
The group this private location has assigned. |
keys
|
keys | keys | |
Last Seen
|
lastSeen | date |
The last seen date. |
Agent Count
|
agentCount | number |
The agent count. |
Name | Path | Type | Description |
---|---|---|---|
Items
|
privatelocationschema |
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | guid |
The identifier. |
Name
|
name | string |
The name assigned to the private location. |
Slug Name
|
slugName | string |
Valid slug name. |
Icon
|
icon | string |
The private location icon. |
Created At
|
created_at | date |
When created at. |
Updated At
|
updated_at | date |
When updated at. |
Check Assignments
|
checkAssignments | checkAssignments |
The check this private location has assigned. |
Group Assignments
|
groupAssignments | groupAssignments |
The group this private location has assigned. |
keys
|
keys | keys |
Name | Path | Type | Description |
---|---|---|---|
Timestamp
|
date-time |
The timestamp. |
The queue size.
Name | Path | Type | Description |
---|---|---|---|
Items
|
number |
Name | Path | Type | Description |
---|---|---|---|
Items
|
number |
Name | Path | Type | Description |
---|---|---|---|
timestamps
|
timestamps | timestamps | |
Queue Size
|
queueSize | queueSize |
The queue size. |
oldestScheduledCheckRun
|
oldestScheduledCheckRun | oldestScheduledCheckRun |
Check tags.
Name | Path | Type | Description |
---|---|---|---|
Items
|
string |
Name | Path | Type | Description |
---|---|---|---|
Success Ratio
|
successRatio | number |
Success ratio of the check over selected date range. Percentage is in decimal form. |
Average
|
avg | number |
Average response time of the check over selected date range in milliseconds. |
P95
|
p95 | number |
P95 response time of the check over selected date range in milliseconds. |
P99
|
p99 | number |
P99 response time of the check over selected date range in milliseconds. |
Name | Path | Type | Description |
---|---|---|---|
Name
|
name | string |
Check name. |
Check ID
|
checkId | string |
Check ID. |
Check Type
|
checkType | string |
Check type. |
Deactivated
|
deactivated | boolean |
Check deactivated. |
Reporting Tag List
|
tags | ReportingTagList |
Check tags. |
aggregate
|
aggregate | ReportingAggregate |
Name | Path | Type | Description |
---|---|---|---|
Items
|
Reporting |
Name | Path | Type | Description |
---|---|---|---|
Name
|
name | string |
The unique name of this runtime. |
Stage
|
stage | string |
Current life stage of a runtime. |
Runtime End of Life
|
runtimeEndOfLife | string |
Date which a runtime will be removed from our platform. |
Default
|
default | boolean |
Indicates if this is the current default runtime provided by Checkly. |
Description
|
description | string |
A short, human readable description of the main updates in this runtime. |
String
|
dependencies.string | string |
The string. |
Name | Path | Type | Description |
---|---|---|---|
Items
|
Runtime |
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | number |
The identifier. |
Name
|
name | string |
The snippet name. |
Script
|
script | string |
Your Node.js code that interacts with the API check lifecycle, or functions as a partial for browser checks. |
Created At
|
created_at | date-time |
When created at. |
Updated At
|
updated_at | date-time |
When updated at. |
Name | Path | Type | Description |
---|---|---|---|
Items
|
Snippet |
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | number |
The identifier. |
Token
|
token | string |
The token. |
Created At
|
created_at | date |
When created at. |
Called At
|
called_at | date |
When called at. |
Updated At
|
updated_at | date |
When updated at. |
Group ID
|
groupId | number |
The group identifier. |
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | number |
The identifier. |
Token
|
token | string |
The token. |
Created At
|
created_at | date |
When created at. |
Called At
|
called_at | date |
When called at. |
Updated At
|
updated_at | date |
When updated at. |
Check ID
|
checkId | string |
The check identifier. |
This is the type 'object'.
This is the basic data type 'string'.