Jump to Content

v1

API Reference

v1

Getting Started

Authentication
Rate Limits

Checkly Public API

Accounts
Alert channels
Alert notifications
- Lists all alert notificationsget
Analytics
Badges
- /v1/badges/checks/{checkId}get
- /v1/badges/groups/{groupId}get
Check alerts
- List all alerts for your accountget
- List alerts for a specific checkget
Check groups
Check results
Check status
- List all check statusesget
- Retrieve check status detailsget
Checks
Heartbeats
Client certificates
Dashboards
Incidents
Incident Updates
Location
- Lists all supported locationsget
Maintenance windows
Private locations
Reporting
- Generates a report with aggregate statistics for checks and check groups.get
Runtimes
- Lists all supported runtimesget
- Shows details for one specific runtimeget
Snippets
Static IPs
Triggers
Environment variables

Getting Started

Authentication
Rate Limits

Checkly Public API

Accounts
Alert channels
Alert notifications
- Lists all alert notificationsget
Analytics
Badges
- /v1/badges/checks/{checkId}get
- /v1/badges/groups/{groupId}get
Check alerts
- List all alerts for your accountget
- List alerts for a specific checkget
Check groups
Check results
Check status
- List all check statusesget
- Retrieve check status detailsget
Checks
Heartbeats
Client certificates
Dashboards
Incidents
Incident Updates
Location
- Lists all supported locationsget
Maintenance windows
Private locations
Reporting
- Generates a report with aggregate statistics for checks and check groups.get
Runtimes
- Lists all supported runtimesget
- Shows details for one specific runtimeget
Snippets
Static IPs
Triggers
Environment variables

Update an TCP check

put https://api.checklyhq.com/v1/checks/tcp/{id}

Updates an TCP check.

Language

Credentials

Header

Click Try It! to start a request and see the response here!