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

Better Stack Heartbeats API

Manage heartbeat monitors for scheduled jobs and cron tasks

Better Stack Heartbeats API is one of 6 APIs that Better Stack 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, API documentation, and an API reference.

This API exposes 6 operations across 3 paths, and defines 9 schemas. It is described by OpenAPI 3.0.3, at version v2.

Requests are made against 3 base URLs: https://uptime.betterstack.com/api/v2, https://uptime.betterstack.com/api/v3, https://betterstack.com/api/v2.

6 operations 3 paths 9 schemas 1 DELETE3 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v2
Base URL
https://uptime.betterstack.com/api/v2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

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

  • bearerAuth — Bearer token authentication. Use a global API token or a team-scoped Uptime API token obtained from Better Stack Settings → API tokens.

Paths & Operations 6

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

Heartbeats 6

Manage heartbeat monitors for scheduled jobs and cron tasks

GET
/heartbeats
Better Stack List Heartbeats
listHeartbeats 1 param → 200401
POST
/heartbeats
Better Stack Create Heartbeat
createHeartbeat body → 201
GET
/heartbeats/{id}
Better Stack Get Heartbeat
getHeartbeat 1 param → 200404
PATCH
/heartbeats/{id}
Better Stack Update Heartbeat
updateHeartbeat 1 param body → 200
DELETE
/heartbeats/{id}
Better Stack Delete Heartbeat
deleteHeartbeat 1 param → 204404
GET
/heartbeats/{id}/availability
Better Stack Get Heartbeat Availability
getHeartbeatAvailability 1 param → 200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are HeartbeatAttributes (12 properties), HeartbeatCreateRequest (7 properties), Pagination (4 properties), HeartbeatUpdateRequest (3 properties). Each schema is shown below with its type and property counts.

AvailabilityResponse
object
Availability summary metrics.
1 property
HeartbeatCreateRequest
object
Request body for creating a heartbeat.
7 properties 2 required
HeartbeatUpdateRequest
object
Request body for updating a heartbeat (all fields optional).
3 properties
HeartbeatListResponse
object
Paginated list of heartbeats.
2 properties
ErrorResponse
object
Standard error response.
1 property
HeartbeatSingleResponse
object
Single heartbeat response.
1 property
HeartbeatAttributes
object
Attributes of a heartbeat monitor.
12 properties
Pagination
object
Pagination links for list responses following JSON:API specification.
4 properties
HeartbeatObject
object
A single heartbeat resource.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

better-stack-heartbeats-api-openapi.yml Raw ↑

Other APIs Better Stack publishes across the network.

Better Stack Escalation Policies API
Better Stack Incidents API
Better Stack Monitors API
Better Stack Status Pages API
Better Stack Team Members API
Where this information came from

This is an independent, third-party profile of Better Stack 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.