Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ilert Heartbeat Monitors API

The Heartbeat Monitors API from ilert — 2 operation(s) for heartbeat monitors.

ilert Heartbeat Monitors API is one of 33 APIs that ilert publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Heartbeat Monitors. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, and 1 JSON Schema.

This API exposes 5 operations across 2 paths, and defines 28 schemas. It is described by OpenAPI 3.0.1, at version v2.2026.5-r.3.

Requests are made against a single base URL, /api.

5 operations 2 paths 28 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
v2.2026.5-r.3
Base URL
https://api.ilert.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

ilert Heartbeat Monitors API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (apiKey). By default, every request must be authenticated.

  • apiKey — The Bearer API key of your user more info .

Paths & Operations 5

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

Heartbeat Monitors 5
GET
/heartbeat-monitors
List heartbeat monitors.
3 params → 200
POST
/heartbeat-monitors
Create a new heartbeat monitor.
1 param body → 201409
GET
/heartbeat-monitors/{id}
Get the heartbeat monitor with specified id.
2 params → 200
PUT
/heartbeat-monitors/{id}
Update an existing heartbeat monitor.
1 param body → 200
DELETE
/heartbeat-monitors/{id}
Delete the specified heartbeat monitor.
1 param → 204

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are AlertSourceRel (38 properties), Service (11 properties), HeartbeatMonitor (11 properties), IncidentNoIncludes (9 properties). Each schema is shown below with its type and property counts.

ServiceStatus
string
the service status
IntegrationType
string
SimpleIdField64
object
For POST and PUT requests only the id field is required for sub entities, e.g. status page - service, alert source - support hour
1 property 1 required
EscalationRule
object
7 properties 1 required
IncidentNoIncludes
object
9 properties
AlertSourceTemplate
object
2 properties
AlertSourceSeverityTemplateMapping
object
2 properties 2 required
UserRel
object
3 properties 1 required
AlertSourcePriorityTemplate
object
2 properties 2 required
AlertSourceRel
object
38 properties 3 required
HeartbeatMonitor
object
11 properties 2 required
ServiceOutage
object
3 properties
HeartbeatMonitorNoIncludes
object
8 properties 2 required
ScheduleRel
object
3 properties
ServiceNoIncludes
object
8 properties
AlertSourceTemplateElement
object
4 properties
IncidentStatus
string
the incident status
Service
object
11 properties
AlertSourcePriorityTemplateMapping
object
2 properties 2 required
AlertSourceTemplateElementArg
object
2 properties
ServiceUptime
object
4 properties
EscalationPolicy
object
8 properties 2 required
TeamRel
object
2 properties
AlertSourceSeverityTemplate
object
2 properties 2 required
ServiceUptimePercentage
object
1 property
HeartbeatMonitorRel
object
4 properties 2 required
AlertPriorityRule
string
AlertSourceLinkTemplate
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ilert-heartbeat-monitors-api-openapi.yml Raw ↑

Other APIs ilert publishes across the network.

ilert Alert Actions API
ilert Alert Sources API
ilert Alerts API
ilert Call Flow Numbers API
ilert Call Flows API
ilert Connectors API
ilert Contacts API
ilert Deployment Events API
ilert Deployment Pipelines API
ilert Escalation Policies API
ilert Event Flows API
ilert Events API