Skip to main content
Checkly Docs home page
Search...
⌘K
Home
Dashboard
Dashboard
Search...
Navigation
Snippets
Page Not Found
Docs
Constructs
CLI
API
Guides
Learn
Comparisons
opentelemetry
POST
Post accounts metrics
Accounts
GET
[beta] Fetch user accounts
GET
[beta] Fetch current account details
GET
[beta] Fetch a given account details
Alert channels
GET
List all alert channels
POST
Create an alert channel
GET
Retrieve an alert channel
PUT
Update an alert channel
DEL
Delete an alert channel
PUT
Update the subscriptions of an alert channel
Alert notifications
GET
Lists all alert notifications
Analytics
GET
API checks
GET
Browser checks
GET
Heartbeat checks
GET
List all available reporting metrics.
GET
Multistep checks
GET
Playwright checks
GET
TCP checks
GET
URL Monitors
Badges
GET
Get v1badgeschecks
GET
Get v1badgesgroups
Check alerts
GET
List all alerts for your account
GET
List alerts for a specific check
Check groups
GET
List all check groups
POST
Create a check group
deprecated
GET
Retrieve one check in a specific group with group settings applied
GET
Retrieve a check group
PUT
Update a check group
deprecated
DEL
Delete a check group.
GET
Retrieve all checks in a specific group with group settings applied
POST
Create a check group (V2)
PUT
Update a check group (V2)
Check results
GET
Lists all check results
deprecated
GET
Retrieve a check result
GET
Lists all check results
Check sessions
POST
Trigger a new check session
GET
Retrieve a check session
GET
Await the completion of a check session
Check status
GET
List all check statuses
GET
Retrieve check status details
Checks
GET
List all checks
POST
Create a check
deprecated
POST
Create an API check
PUT
Update an API check
POST
Create a browser check
PUT
Update a browser check
POST
Create a multi-step check
PUT
Update a multi-step check
POST
Create a TCP check
PUT
Update an TCP check
GET
Retrieve a check
PUT
Update a check
deprecated
DEL
Delete a check
Heartbeats
POST
Create a heartbeat check
PUT
Update a heartbeat check
GET
Get heartbeat availability
GET
Get a list of events for a heartbeat
GET
Get a specific Heartbeat event
Monitors
POST
Create a URL monitor
PUT
Update an URL Monitor
Client certificates
GET
Lists all client certificates.
POST
Creates a new client certificate.
GET
Shows one client certificate.
DEL
Deletes a client certificate.
Dashboards
GET
List all dashboards
POST
Create a dashboard
GET
Retrieve a dashboard
PUT
Update a dashboard
DEL
Delete a dashboard
Incidents
POST
Create an incident
GET
Retrieve an incident
PUT
Update an incident
DEL
Delete an incident
Incident Updates
POST
Create an incident update
PUT
Update an incident update
DEL
Delete an incident update
Location
GET
Lists all supported locations
Maintenance windows
GET
List all maintenance windows
POST
Create a maintenance window
GET
Retrieve a maintenance window
PUT
Update a maintenance window
DEL
Delete a maintenance window
Private locations
GET
List all private locations
POST
Create a private location
GET
Retrieve a private location
PUT
Update a private location
DEL
Remove a private location
POST
Generate a new API Key for a private location
DEL
Remove an existing API key for a private location
GET
Get private location health metrics from a window of time.
Reporting
GET
Generates a report with aggregate statistics for checks and check groups.
Runtimes
GET
Lists all supported runtimes
GET
Shows details for one specific runtime
Snippets
List all snippets
Create a snippet
Retrieve a snippet
Update a snippet
Delete a snippet
Static IPs
GET
Lists all source IPs for check runs
GET
Lists all source IPs for check runs
GET
Lists all source IPs for check runs as txt file
GET
Lists all source IPv6s for check runs
GET
Lists all source IPv6s for check runs
GET
Lists all source IPv6s for check runs as a txt file
Status Pages
GET
Retrieve all status pages.
POST
Create a new status page.
GET
Retrieve a single status page by id.
PUT
Update an existing status page.
DEL
Delete a status page.
GET
Get all subscriptions for a specific status page
DEL
Delete a subscription belonging to a specific status page
Status Page Incidents
GET
Retrieve the latest incidents with pagination.
POST
Create a new incident.
GET
Retrieve an incident by id.
PUT
Update an existing incident.
DEL
Delete an incident.
GET
Retrieve the 100 latest incident updates of a specific incident.
POST
Add a new incident update to a specific incident.
GET
Retrieve an incident update by id.
PUT
Update an existing incident update.
DEL
Delete an incident update.
Status Page Services
GET
Get all services
POST
Create a service
GET
Get a single service
PUT
Update a service
DEL
Delete a service
Triggers
GET
Get the check group trigger
deprecated
POST
Create the check group trigger
deprecated
DEL
Delete the check group trigger
deprecated
GET
Get the check trigger
deprecated
POST
Create the check trigger
deprecated
DEL
Delete the check trigger
deprecated
Environment variables
GET
List all environment variables
POST
Create an environment variable
GET
Retrieve an environment variable
PUT
Update an environment variable
DEL
Delete an environment variable
opentelemetry
POST
Post accounts metrics
Accounts
GET
[beta] Fetch user accounts
GET
[beta] Fetch current account details
GET
[beta] Fetch a given account details
Alert channels
GET
List all alert channels
POST
Create an alert channel
GET
Retrieve an alert channel
PUT
Update an alert channel
DEL
Delete an alert channel
PUT
Update the subscriptions of an alert channel
Alert notifications
GET
Lists all alert notifications
Analytics
GET
API Checks Analytics
GET
Browser Checks Analytics
GET
Get Heartbeat Check Analytics
GET
List all available reporting metrics.
GET
Get Multistep Check Analytics
GET
Playwright checks
GET
Get TCP Check Analytics
GET
Get URL Monitor Analytics
Badges
GET
Get v1badgeschecks
GET
Get v1badgesgroups
Check alerts
GET
List all alerts for your account
GET
List alerts for a specific check
Check groups
GET
List all check groups
POST
Create a check group
deprecated
GET
Retrieve one check in a specific group with group settings applied
GET
Retrieve a check group
PUT
Update a check group
deprecated
DEL
Delete a check group.
GET
Retrieve all checks in a specific group with group settings applied
POST
Create a check group (V2)
PUT
Update a check group (V2)
Check results
GET
Lists all check results
deprecated
GET
Retrieve a check result
GET
Lists all check results
Check sessions
POST
Trigger a new check session
GET
Retrieve a check session
GET
Await the completion of a check session
Check status
GET
List all check statuses
GET
Retrieve check status details
Checks
GET
List all checks
POST
Create a check
deprecated
POST
Create an API check
PUT
Update an API check
POST
Create a browser check
PUT
Update a browser check
POST
Create a multi-step check
PUT
Update a multi-step check
POST
Create a TCP check
PUT
Update an TCP check
GET
Retrieve a check
PUT
Update a check
deprecated
DEL
Delete a check
Heartbeats
POST
Create a heartbeat check
PUT
Update a heartbeat check
GET
Get heartbeat availability
GET
Get a list of events for a heartbeat
GET
Get a specific Heartbeat event
Monitors
POST
Create a URL monitor
PUT
Update an URL Monitor
Client certificates
GET
Lists all client certificates.
POST
Creates a new client certificate.
GET
Shows one client certificate.
DEL
Deletes a client certificate.
Dashboards
GET
List all dashboards
POST
Create a dashboard
GET
Retrieve a dashboard
PUT
Update a dashboard
DEL
Delete a dashboard
Incidents
POST
Create an incident
GET
Retrieve an incident
PUT
Update an incident
DEL
Delete an incident
Incident Updates
POST
Create an incident update
PUT
Update an incident update
DEL
Delete an incident update
Location
GET
Lists all supported locations
Maintenance windows
GET
List all maintenance windows
POST
Create a maintenance window
GET
Retrieve a maintenance window
PUT
Update a maintenance window
DEL
Delete a maintenance window
Private locations
GET
List all private locations
POST
Create a private location
GET
Retrieve a private location
PUT
Update a private location
DEL
Remove a private location
POST
Generate a new API Key for a private location
DEL
Remove an existing API key for a private location
GET
Get private location health metrics from a window of time.
Reporting
GET
Generates a report with aggregate statistics for checks and check groups.
Runtimes
GET
Lists all supported runtimes
GET
Shows details for one specific runtime
Snippets
GET
List all snippets
POST
Create a snippet
GET
Retrieve a snippet
PUT
Update a snippet
DEL
Delete a snippet
Static IPs
GET
Lists all source IPs for check runs
GET
Lists all source IPs for check runs
GET
Lists all source IPs for check runs as txt file
GET
Lists all source IPv6s for check runs
GET
Lists all source IPv6s for check runs
GET
Lists all source IPv6s for check runs as a txt file
Status Pages
GET
Retrieve all status pages.
POST
Create a new status page.
GET
Retrieve a single status page by id.
PUT
Update an existing status page.
DEL
Delete a status page.
GET
Get all subscriptions for a specific status page
DEL
Delete a subscription belonging to a specific status page
Status Page Incidents
GET
Retrieve the latest incidents with pagination.
POST
Create a new incident.
GET
Retrieve an incident by id.
PUT
Update an existing incident.
DEL
Delete an incident.
GET
Retrieve the 100 latest incident updates of a specific incident.
POST
Add a new incident update to a specific incident.
GET
Retrieve an incident update by id.
PUT
Update an existing incident update.
DEL
Delete an incident update.
Status Page Services
GET
Get all services
POST
Create a service
GET
Get a single service
PUT
Update a service
DEL
Delete a service
Triggers
GET
Get the check group trigger
deprecated
POST
Create the check group trigger
deprecated
DEL
Delete the check group trigger
deprecated
GET
Get the check trigger
deprecated
POST
Create the check trigger
deprecated
DEL
Delete the check trigger
deprecated
Environment variables
GET
List all environment variables
POST
Create an environment variable
GET
Retrieve an environment variable
PUT
Update an environment variable
DEL
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.
Retrieve a snippet
Browser Check Snippets
API Check Snippets
Assistant
Responses are generated using AI and may contain mistakes.