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
Email	ttaylor@hitachisolutions.com

Connector Metadata
Publisher	Troy Taylor
Website	https://www.checklyhq.com/
Privacy policy	https://www.checklyhq.com/privacy
Categories	IT Operations

Creating a connection

The connector supports the following authentication types:

Default	Parameters for creating connection.	All regions	Not shareable

Default

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

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Create a browser check	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
Create a check [DEPRECATED]	[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
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 402 when you are over the limit of your plan. When using the globalAlertSetting, the alertSetting can be null
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 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.
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 PUT /checks/api/{id} or PUT /checks/browser/{id}. Updates a new API or browser check.
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.

Create a browser check

Operation ID:

PostV1ChecksBrowser

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

Create a check [DEPRECATED]

Operation ID:

PostV1Checks

[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

Create a check group

Operation ID:

PostV1Checkgroups

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

Create a dashboard

Operation ID:

PostV1Dashboards

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

Create a environment variable

Operation ID:

PostV1Variables

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

Create a maintenance window

Operation ID:

PostV1Maintenancewindows

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

Create a private location

Operation ID:

PostV1Privatelocations

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

Body

commonPrivateLocationSchemaResponse

Create a snippet

Operation ID:

PostV1Snippets

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

Create an alert channel

Operation ID:

PostV1Alertchannels

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

Create an API check

Operation ID:

PostV1ChecksApi

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

Create the check group trigger

Operation ID:

PostV1TriggersCheckgroupsGroupid

Creates the check group trigger.

Parameters

Name	Key	Required	Type	Description
Group ID	groupId	True	integer	The group identifier.

Returns

Body

CheckGroupTrigger

Create the check trigger

Operation ID:

PostV1TriggersChecksCheckid

Creates the check trigger.

Parameters

Name	Key	Required	Type	Description
Check ID	checkId	True	string	The check identifier.

Returns

Body

CheckTrigger

Delete a check

Operation ID:

DeleteV1ChecksId

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.

Delete a check group

Operation ID:

DeleteV1CheckgroupsId

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.

Delete a dashboard

Operation ID:

DeleteV1DashboardsDashboardid

Permanently removes a dashboard.

Parameters

Name	Key	Required	Type	Description
ID	dashboardId	True	string	The dashboard identifier.

Delete a maintenance window

Operation ID:

DeleteV1MaintenancewindowsId

Permanently removes a maintenance window.

Parameters

Name	Key	Required	Type	Description
ID	id	True	integer	The identifier.

Delete a snippet

Operation ID:

DeleteV1SnippetsId

Permanently removes a snippet.

Parameters

Name	Key	Required	Type	Description
ID	id	True	integer	The identifier.

Delete an alert channel

Operation ID:

DeleteV1AlertchannelsId

Permanently removes an alert channel.

Parameters

Name	Key	Required	Type	Description
ID	id	True	integer	The identifier.

Delete an environment variable

Operation ID:

DeleteV1VariablesKey

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.

Delete the check group trigger

Operation ID:

DeleteV1TriggersCheckgroupsGroupid

Deletes the check groups trigger.

Parameters

Name	Key	Required	Type	Description
Group ID	groupId	True	integer	The group identifier.

Delete the check trigger

Operation ID:

DeleteV1TriggersChecksCheckid

Deletes the check trigger.

Parameters

Name	Key	Required	Type	Description
Check ID	checkId	True	string	The check identifier.

Generate a new API Key for a private location

Operation ID:

PostV1PrivatelocationsIdKeys

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 customizable report for all Browser Check metrics

Operation ID:

GetV2ReportingBrowserchecksId

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 aggregate statistics for checks and check groups

Operation ID:

GetV1Reporting

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

Operation ID:

GetV1BadgesChecksCheckid

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

Operation ID:

GetV1BadgesGroupsGroupid

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

Operation ID:

GetV1PrivatelocationsIdMetrics

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

Body

privateLocationsMetricsHistoryResponseSchema

Get the check group trigger

Operation ID:

GetV1TriggersCheckgroupsGroupid

Finds the check group trigger.

Parameters

Name	Key	Required	Type	Description
Group ID	groupId	True	integer	The group identifier.

Returns

Body

CheckGroupTrigger

Get the check trigger

Operation ID:

GetV1TriggersChecksCheckid

Finds the check trigger.

Parameters

Name	Key	Required	Type	Description
Check ID	checkId	True	string	The check identifier.

Returns

Body

CheckTrigger

List alerts for a specific check

Operation ID:

GetV1CheckalertsCheckid

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

List all alert channels

Operation ID:

GetV1Alertchannels

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

List all alerts for your account

Operation ID:

GetV1Checkalerts

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

List all check groups

Operation ID:

GetV1Checkgroups

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

List all check statuses

Operation ID:

GetV1Checkstatuses

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

List all checks

Operation ID:

GetV1Checks

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

List all dashboards

Operation ID:

GetV1Dashboards

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

List all environment variables

Operation ID:

GetV1Variables

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

List all maintenance windows

Operation ID:

GetV1Maintenancewindows

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

List all private locations

Operation ID:

GetV1Privatelocations

Lists all private locations in your account.

Returns

Items

privateLocationsListSchema

List all snippets

Operation ID:

GetV1Snippets

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 all check results

Operation ID:

GetV1CheckresultsCheckid

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 locations

Operation ID:

GetV1Locations

Lists all supported locations.

Returns

Items

LocationList

Lists all supported runtimes

Operation ID:

GetV1Runtimes

Lists all supported runtimes and the included NPM packages for Browser checks and setup & teardown scripts for API checks.

Returns

Items

RuntimeList

Remove a private location

Operation ID:

DeleteV1PrivatelocationsId

Permanently removes a private location.

Parameters

Name	Key	Required	Type	Description
ID	id	True	string	The identifier.

Remove an existing API key for a private location

Operation ID:

DeleteV1PrivatelocationsIdKeysKeyid

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.

Retrieve a check

Operation ID:

GetV1ChecksId

Show details of a specific API or browser check.

Parameters

Name	Key	Required	Type	Description
ID	id	True	string	The identifier.

Returns

Body

Check

Retrieve a check group

Operation ID:

GetV1CheckgroupsId

Show details of a specific check group.

Parameters

Name	Key	Required	Type	Description
ID	id	True	integer	The identifier.

Returns

Body

CheckGroup

Retrieve a check result

Operation ID:

GetV1CheckresultsCheckidCheckresultid

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

Retrieve a maintenance window

Operation ID:

GetV1MaintenancewindowsId

Show details of a specific maintenance window.

Parameters

Name	Key	Required	Type	Description
ID	id	True	integer	The identifier.

Returns

Body

MaintenanceWindow

Retrieve a private location

Operation ID:

GetV1PrivatelocationsId

Show details of a specific private location.

Parameters

Name	Key	Required	Type	Description
ID	id	True	string	The identifier.

Returns

Body

privatelocationschema

Retrieve a snippet

Operation ID:

GetV1SnippetsId

Show details of a specific snippet.

Parameters

Name	Key	Required	Type	Description
ID	id	True	integer	The identifier.

Returns

Body

Snippet

Retrieve all checks in a specific group with group settings applied

Operation ID:

GetV1CheckgroupsIdChecks

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

Retrieve an alert channel

Operation ID:

GetV1AlertchannelsId

Show details of a specific alert channel.

Parameters

Name	Key	Required	Type	Description
ID	id	True	integer	The identifier.

Returns

Body

AlertChannel

Retrieve an environment variable

Operation ID:

GetV1VariablesKey

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

Retrieve check status details

Operation ID:

GetV1CheckstatusesCheckid

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

Retrieve one check in a specific group with group settings applied

Operation ID:

GetV1CheckgroupsGroupidChecksCheckid

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 details for one specific runtime

Operation ID:

GetV1RuntimesId

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

Update a browser check

Operation ID:

PutV1ChecksBrowserId

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

Update a check [DEPRECATED]

Operation ID:

PutV1ChecksId

[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

Update a check group

Operation ID:

PutV1CheckgroupsId

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

Update a dashboard

Operation ID:

PutV1DashboardsDashboardid

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

Update a environment variable

Operation ID:

PutV1VariablesKey

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

Update a maintenance window

Operation ID:

PutV1MaintenancewindowsId

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

Update a private location

Operation ID:

PutV1PrivatelocationsId

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

Body

commonPrivateLocationSchemaResponse

Update a snippet

Operation ID:

PutV1SnippetsId

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

Operation ID:

PutV1AlertchannelsId

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

Update an API check

Operation ID:

PutV1ChecksApiId

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

Operation ID:

PutV1AlertchannelsIdSubscriptions

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

Body

AlertChanelSubscription

Definitions

AlertChannelConfig

The configuration of the alert channel.

Name	Path	Type	Description
Alert Channel Config		object	The configuration of the alert channel.

AlertChanelSubscription

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.

AlertChanelSubscriptionList

All checks subscribed to this channel.

Name	Path	Type	Description
Items		AlertChanelSubscription

AlertChannel

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.

AlertChannelList

Name	Path	Type	Description
Items		AlertChannel

CheckAlert

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.

CheckAlertList

Name	Path	Type	Description
Items		CheckAlert

CheckGroupTagList

Tags for organizing and filtering checks.

Name	Path	Type	Description
Items		string

CheckGroupLocationList

An array of one or more data center locations where to run the checks.

Name	Path	Type	Description
Items		string

KeyValue

Name	Path	Type	Description
Key	key	string	The key.
Value	value	string	The value.
Locked	locked	boolean	Whether locked.

HeaderList

Name	Path	Type	Description
Items		KeyValue

QueryParameterList

Name	Path	Type	Description
Items		KeyValue

Assertion

Name	Path	Type	Description
Source	source	string	The source.
Property	property	string	The property.
Comparison	comparison	string	The comparison.
Target	target	string	The target.

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.

Name	Path	Type	Description
Items		Assertion

BasicAuth

Name	Path	Type	Description
Username	username	string	The username.
Password	password	string	The password.

CheckGroupAPICheckDefaults

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

CheckGroupBrowserCheckDefaults

The check group browser check defaults.

Name	Path	Type	Description
Check Group Browser Check Defaults		object	The check group browser check defaults.

EnvironmentVariable

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.

EnvironmentVariableList

Name	Path	Type	Description
Items		EnvironmentVariable

AlertSettingsRunBasedEscalation

Name	Path	Type	Description
Failed Run Threshold	failedRunThreshold	number	After how many failed consecutive check runs an alert notification should be send.

AlertSettingsTimeBasedEscalation

Name	Path	Type	Description
Minutes Failing Threshold	minutesFailingThreshold	number	After how many minutes after a check starts failing an alert should be send.

AlertSettingsReminders

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.

AlertSettingsSSLCertificates

[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.

CheckGroupAlertSettings

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] sslCertificates is deprecated and is not longer used. Please ignore it, will be removed in a future version.

Model1

Alert channel subscription.

Name	Path	Type	Description
Alert Channel ID	alertChannelId	number	The alert channel identifier.
Activated	activated	boolean	Whether activated.

AlertChannelSubscriptionCreateList

List of alert channel subscriptions.

Name	Path	Type	Description
Alert Channel Subscription		Model1	Alert channel subscription.

privateLocations

An array of one or more private locations where to run the check.

Name	Path	Type	Description
Items		string

CheckGroup

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.

CheckGroupList

Name	Path	Type	Description
Items		CheckGroup

CheckLocationList

An array of one or more data center locations where to run this check.

Name	Path	Type	Description
Items		string

CheckTagList

Tags for organizing and filtering checks.

Name	Path	Type	Description
Items		string

CheckAlertSettings

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] sslCertificates is deprecated and is not longer used. Please ignore it, will be removed in a future version.

CheckAlertChannelSubscription

Name	Path	Type	Description
Alert Channel ID	alertChannelId	number	The alert channel identifier.
Activated	activated	boolean	Whether activated.

CheckAlertChannelSubscriptionList

Name	Path	Type	Description
Items		CheckAlertChannelSubscription

CheckRequest

The check request.

Name	Path	Type	Description
Check Request		object	The check request.

CheckEnvironmentVariableList

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

CheckAlertEmail

Name	Path	Type	Description
Address	address	string	The address.

CheckAlertEmailList

Name	Path	Type	Description
Items		CheckAlertEmail

Model4

Name	Path	Type	Description
Items		KeyValue

Model5

Name	Path	Type	Description
Items		KeyValue

CheckAlertWebhook

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

CheckAlertWebhookList

Name	Path	Type	Description
Items		CheckAlertWebhook

CheckAlertSlack

Name	Path	Type	Description
URL	url	string	The URL address.

CheckAlertSlackList

Name	Path	Type	Description
Items		CheckAlertSlack

CheckAlertSMS

Name	Path	Type	Description
Number	number	string	The number.
Name	name	string	The name.

CheckAlertSMSList

Name	Path	Type	Description
Items		CheckAlertSMS

CheckAlertChannels

Name	Path	Type	Description
email	email	CheckAlertEmailList
webhook	webhook	CheckAlertWebhookList
slack	slack	CheckAlertSlackList
sms	sms	CheckAlertSMSList

CheckGroupCheck

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.

Model8

Name	Path	Type	Description
Items		CheckGroupCheck

assertions

List of API check assertions.

Name	Path	Type	Description
Items		string

headers

The headers.

Name	Path	Type	Description
Headers		object	The headers.

params

The parameters.

Name	Path	Type	Description
Params		object	The parameters.

request

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.

timings

The timings.

Name	Path	Type	Description
Timings		object	The timings.

timingPhases

The timing phases.

Name	Path	Type	Description
Timing Phases		object	The timing phases.

response

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.

jobLog

The job log.

Name	Path	Type	Description
Job Log		object	The job log.

jobAssets

Assets generated from the check run.

Name	Path	Type	Description
Items		string

CheckResultAPI

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.

errors

List of errors on the check run.

Name	Path	Type	Description
Items		string

Model9

Check run log results.

Name	Path	Type	Description
Items		string

traceSummary

The trace summary.

Name	Path	Type	Description
Trace Summary		object	The trace summary.

pages

List of pages used on the check run.

Name	Path	Type	Description
Items		string

CheckResultBrowser

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.

CheckResult

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.

CheckResultList

Name	Path	Type	Description
Items		CheckResult

CheckStatus

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.

CheckStatusList

Name	Path	Type	Description
Items		CheckStatus

Check

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.

CheckList

Name	Path	Type	Description
Items		Check

Model14

Name	Path	Type	Description
Items		KeyValue

Model15

Name	Path	Type	Description
Items		KeyValue

Model16

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

CheckAPI

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.

CheckBrowser

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.

DashboardTagList

A list of one or more tags that filter which checks to display on the dashboard.

Name	Path	Type	Description
Items		string

Dashboard

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.

DashboardsList

Name	Path	Type	Description
Items		Dashboard

Location

Name	Path	Type	Description
Region	region	string	The unique identifier of this location.
Name	name	string	Friendly name of this location.

LocationList

Name	Path	Type	Description
Items		Location

MaintenanceWindowTagList

The names of the checks and groups maintenance window should apply to.

Name	Path	Type	Description
Items		string

MaintenanceWindow

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.

MaintenanceWindowList

The maintenance window list.

Name	Path	Type	Description
Items		MaintenanceWindow

CheckAssignment

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.

checkAssignments

The check this private location has assigned.

Name	Path	Type	Description
Items		CheckAssignment

GroupAssignment

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.

groupAssignments

The group this private location has assigned.

Name	Path	Type	Description
Items		GroupAssignment

privateLocationKeys

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.

keys

Name	Path	Type	Description
Items		privateLocationKeys

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
Last Seen	lastSeen	date	The last seen date.
Agent Count	agentCount	number	The agent count.

privateLocationsListSchema

Name	Path	Type	Description
Items		privatelocationschema

commonPrivateLocationSchemaResponse

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

timestamps

Name	Path	Type	Description
Timestamp		date-time	The timestamp.

queueSize

The queue size.

Name	Path	Type	Description
Items		number

oldestScheduledCheckRun

Name	Path	Type	Description
Items		number

privateLocationsMetricsHistoryResponseSchema

Name	Path	Type	Description
timestamps	timestamps	timestamps
Queue Size	queueSize	queueSize	The queue size.
oldestScheduledCheckRun	oldestScheduledCheckRun	oldestScheduledCheckRun

ReportingTagList

Check tags.

Name	Path	Type	Description
Items		string

ReportingAggregate

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.

Reporting

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

ReportingList

Name	Path	Type	Description
Items		Reporting

Runtime

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.

RuntimeList

Name	Path	Type	Description
Items		Runtime

Snippet

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.

SnippetList

Name	Path	Type	Description
Items		Snippet

CheckGroupTrigger

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.

CheckTrigger

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.

object

This is the type 'object'.

string

This is the basic data type 'string'.