Skip to main content
Checkly Docs home page
Search...
⌘K
Home
Dashboard
Dashboard
Search...
Navigation
Location
Page Not Found
Docs
Constructs
CLI
API
Guides
Learn
Comparisons
Accounts
Fetch user accounts
Fetch current account details
Fetch a given account details
Alert channels
List all alert channels
Create an alert channel
Retrieve an alert channel
Update an alert channel
Delete an alert channel
Update the subscriptions of an alert channel
Alert notifications
Lists all alert notifications
Analytics
Api checks
Browser checks
Heartbeat checks
List all available reporting metrics
Multistep checks
Playwright checks
Tcp checks
Url monitors
Badges
Get v1badgeschecks
Get v1badgesgroups
Check alerts
List all alerts for your account
List alerts for a specific check
Check groups
List all check groups
Create a check group
Retrieve one check in a specific group with group settings applied
Retrieve a check group
Update a check group
Delete a check group
Retrieve all checks in a specific group with group settings applied
Create a check group v2
Update a check group v2
Check results
Lists all check results
Retrieve a check result
Lists all check results 1
Check sessions
Trigger a new check session
Retrieve a check session
Await the completion of a check session
Check status
List all check statuses
Retrieve check status details
Checks
List all checks
Create a check
Create an api check
Update an api check
Create a browser check
Update a browser check
Create a multi step check
Update a multi step check
Create a tcp check
Update an tcp check
Retrieve a check
Update a check
Delete a check
Heartbeats
Create a heartbeat check
Update a heartbeat check
Get heartbeat availability
Get a list of events for a heartbeat
Get a specific heartbeat event
Monitors
Create a url monitor
Update an url monitor
Client certificates
Lists all client certificates
Creates a new client certificate
Shows one client certificate
Deletes a client certificate
Dashboards
List all dashboards
Create a dashboard
Retrieve a dashboard
Update a dashboard
Delete a dashboard
Incidents
Create an incident
Retrieve an incident
Update an incident
Delete an incident
Incident Updates
Create an incident update
Update an incident update
Delete an incident update
Location
Lists all supported locations
Maintenance windows
List all maintenance windows
Create a maintenance window
Retrieve a maintenance window
Update a maintenance window
Delete a maintenance window
Private locations
List all private locations
Create a private location
Retrieve a private location
Update a private location
Remove a private location
Generate a new api key for a private location
Remove an existing api key for a private location
Get private location health metrics from a window of time
Reporting
Generates a report with aggregate statistics for checks and check groups
Runtimes
Lists all supported runtimes
Shows details for one specific runtime
Snippets
List all snippets
Create a snippet
Retrieve a snippet
Update a snippet
Delete a snippet
Static IPs
Lists all source ips for check runs
Lists all source ips for check runs 1
Lists all source ips for check runs as txt file
Lists all source ipv6s for check runs
Lists all source ipv6s for check runs 1
Lists all source ipv6s for check runs as a txt file
Status Pages
Retrieve all status pages
Create a new status page
Retrieve a single status page by id
Update an existing status page
Delete a status page
Get all subscriptions for a specific status page
Delete a subscription belonging to a specific status page
Status Page Incidents
Retrieve the latest incidents with pagination
Create a new incident
Retrieve an incident by id
Update an existing incident
Delete an incident
Retrieve the 100 latest incident updates of a specific incident
Add a new incident update to a specific incident
Retrieve an incident update by id
Update an existing incident update
Delete an incident update
Status Page Services
Get all services
Create a service
Get a single service
Update a service
Delete a service
Triggers
Get the check group trigger
Create the check group trigger
Delete the check group trigger
Get the check trigger
Create the check trigger
Delete the check trigger
Environment variables
List all environment variables
Create an environment variable
Retrieve an environment variable
Update an environment variable
Delete an environment variable
opentelemetry
Post accounts metrics
Accounts
[beta] fetch user accounts
[beta] fetch current account details
[beta] fetch a given account details
Alert channels
List all alert channels
Create an alert channel
Retrieve an alert channel
Update an alert channel
Delete an alert channel
Update the subscriptions of an alert channel
Alert notifications
Lists all alert notifications
Analytics
Api checks
Browser checks
Heartbeat checks
List all available reporting metrics
Multistep checks
Playwright checks
Tcp checks
Url monitors
Badges
Get v1badgeschecks
Get v1badgesgroups
Check alerts
List all alerts for your account
List alerts for a specific check
Check groups
List all check groups
Create a check group
Retrieve one check in a specific group with group settings applied
Retrieve a check group
Update a check group
Delete a check group
Retrieve all checks in a specific group with group settings applied
Create a check group v2
Update a check group v2
Check results
Lists all check results
Retrieve a check result
Lists all check results 1
Check sessions
Trigger a new check session
Retrieve a check session
Await the completion of a check session
Check status
List all check statuses
Retrieve check status details
Checks
List all checks
Create a check
Create an api check
Update an api check
Create a browser check
Update a browser check
Create a multi step check
Update a multi step check
Create a tcp check
Update an tcp check
Retrieve a check
Update a check
Delete a check
Heartbeats
Create a heartbeat check
Update a heartbeat check
Get heartbeat availability
Get a list of events for a heartbeat
Get a specific heartbeat event
Monitors
Create a url monitor
Update an url monitor
Client certificates
Lists all client certificates
Creates a new client certificate
Shows one client certificate
Deletes a client certificate
Dashboards
List all dashboards
Create a dashboard
Retrieve a dashboard
Update a dashboard
Delete a dashboard
Error Groups
List all error groups for a specific check
Retrieve one error group
Update an error group mainly used for archiving error groups
Incidents
Create an incident
Retrieve an incident
Update an incident
Delete an incident
Incident Updates
Create an incident update
Update an incident update
Delete an incident update
Location
Lists all supported locations
Maintenance windows
List all maintenance windows
Create a maintenance window
Retrieve a maintenance window
Update a maintenance window
Delete a maintenance window
Private locations
List all private locations
Create a private location
Retrieve a private location
Update a private location
Remove a private location
Generate a new api key for a private location
Remove an existing api key for a private location
Get private location health metrics from a window of time
Reporting
Generates a report with aggregate statistics for checks and check groups
Runtimes
Lists all supported runtimes
Shows details for one specific runtime
Snippets
List all snippets
Create a snippet
Retrieve a snippet
Update a snippet
Delete a snippet
Static IPs
Lists all source ips for check runs
Lists all source ips for check runs 1
Lists all source ips for check runs as txt file
Lists all source ipv6s for check runs
Lists all source ipv6s for check runs 1
Lists all source ipv6s for check runs as a txt file
Status Pages
Retrieve all status pages
Create a new status page
Retrieve a single status page by id
Update an existing status page
Delete a status page
Get all subscriptions for a specific status page
Delete a subscription belonging to a specific status page
Status Page Incidents
Retrieve the latest incidents with pagination
Create a new incident
Retrieve an incident by id
Update an existing incident
Delete an incident
Retrieve the 100 latest incident updates of a specific incident
Add a new incident update to a specific incident
Retrieve an incident update by id
Update an existing incident update
Delete an incident update
Status Page Services
Get all services
Create a service
Get a single service
Update a service
Delete a service
Triggers
Get the check group trigger
Create the check group trigger
Delete the check group trigger
Get the check trigger
Create the check trigger
Delete the check trigger
Environment variables
List all environment variables
Create an environment variable
Retrieve an environment variable
Update an environment variable
Delete an environment variable
404
Looks like this page has moved!
Please try searching for the new page you’re looking for in the search bar or sidebar.