How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Checkly

Checkly Heartbeats API

The Heartbeats API from Checkly — 5 operation(s) for heartbeats.

Documentation Provider Profile APIs.io OpenAPI GitHub

Checkly Heartbeats API is one of 42 APIs that Checkly publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Heartbeats. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 5 paths, and defines 32 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.checklyhq.com.

5 operations 5 paths 32 schemas 3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.checklyhq.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Checkly Heartbeats API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Bearer) (Bearer). By default, every request must be authenticated.

  • Bearer — The Checkly Public API uses API keys to authenticate requests. You can get the API Key here . Your API key is like a password: keep it secure! Authentication t…

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Heartbeats 5
POST
/v1/checks/heartbeat
Create a heartbeat check
postV1ChecksHeartbeat 2 params body → 201400401402403429
PUT
/v1/checks/heartbeat/{id}
Update a heartbeat check
putV1ChecksHeartbeatId 3 params body → 200400401402403404429
GET
/v1/checks/heartbeats/{checkId}/availability
Get heartbeat availability
getV1ChecksHeartbeatsCheckidAvailability 4 params → 200400401403404429
GET
/v1/checks/heartbeats/{checkId}/events
Get a list of events for a heartbeat
getV1ChecksHeartbeatsCheckidEvents 5 params → 200400401403404429
GET
/v1/checks/heartbeats/{checkId}/events/{id}
Get a specific Heartbeat event
getV1ChecksHeartbeatsCheckidEventsId 3 params → 200400401403404429

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are ChecksV1HeartbeatCheckCreate (33 properties), ChecksV1HeartbeatCheckUpdate (33 properties), ChecksV1HeartbeatCheckMutationResponse (18 properties), ChecksV1Heartbeat (6 properties). Each schema is shown below with its type and property counts.

attributes
object
ChecksV1HeartbeatRequest
object
5 properties 4 required
ChecksV1HeartbeatResponseAlertChannels
objectnull
4 properties
ChecksV1HeartbeatResponseAlertSlack
object
1 property 1 required
HeartbeatsV1EventStats
object
2 properties
Model2
string
ChecksV1Heartbeat
object
6 properties 4 required
UnauthorizedError
object
4 properties 2 required
ChecksV1CheckIntent
objectnull
3 properties 1 required
ChecksV1HeartbeatCheckUpdate
object
33 properties
TooManyRequestsError
object
4 properties 2 required
ChecksV1HeartbeatCheckMutationResponse
object
18 properties 1 required
HeartbeatsV1Event
object
5 properties 1 required
ChecksV1HeartbeatResponseTriggerIncident
objectnull
Determines whether the check or monitor should create and resolve an incident based on its alert configuration. Useful for status page automation.
5 properties 5 required
HeartbeatsV1AvailabilityResponse
objectnull
2 properties
ChecksV1HeartbeatResponseAlertSms
object
2 properties 2 required
HeartbeatsV1EventsForCheck
object
2 properties
ChecksV1HeartbeatResponseAlertSettings
objectnull
Alert settings.
6 properties
ChecksV1HeartbeatCheckCreate
object
33 properties 2 required
ForbiddenError
object
3 properties 2 required
ApiError
object
3 properties 3 required
ChecksV1HeartbeatResponseAlertEmail
object
1 property 1 required
NotFoundError
object
3 properties 2 required
HeartbeatsV1EventResponse
object
2 properties
error
string
HeartbeatsV1AvailabilitySuccessRatio
object
2 properties
Model4
string
ChecksV1HeartbeatResponseAlertWebhook
object
5 properties 1 required
Model1
string
ChecksV1HeartbeatResponseKeyValue
object
3 properties 2 required
HeartbeatsV1EventsResponse
array
ChecksV1HeartbeatResponseAlertChannelSubscription
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

checkly-heartbeats-api-openapi.yml Raw ↑

Other APIs Checkly publishes across the network.

Checkly
AE Profile APIs.io
Checkly Accounts API
AE Profile APIs.io
Checkly Alert Channels API
AE Profile APIs.io
Checkly Analytics API
AE Profile APIs.io
Checkly Check Alerts API
AE Profile APIs.io
Checkly Check Groups API
AE Profile APIs.io
Checkly Check Results API
AE Profile APIs.io
Checkly Checks API
AE Profile APIs.io
Checkly Dashboards API
AE Profile APIs.io
Checkly Incidents API
AE Profile APIs.io
Checkly Maintenance Windows API
AE Profile APIs.io
Checkly Private Locations API
AE Profile APIs.io
#Heartbeats
← Back to C APIs
API Details
ID
checkly:checkly-heartbeats-api
Base URL
https://api.checklyhq.com
Docs
https://www.checklyhq.com
Provider
Checkly
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=checkly-heartbeats-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/checkly-heartbeats-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Checkly Heartbeats API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.