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

OpsGenie Heartbeats API

Operations for creating, managing, and pinging heartbeat monitors.

OpsGenie Heartbeats API is one of 15 APIs that OpsGenie publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Heartbeats. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and 3 JSON Schemas.

This API exposes 8 operations across 5 paths, and defines 7 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against 2 base URLs: https://api.opsgenie.com, https://api.eu.opsgenie.com.

8 operations 5 paths 7 schemas 1 DELETE3 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.opsgenie.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

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

  • genieKey — API key authentication using the GenieKey scheme.

Paths & Operations 8

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

Heartbeats 8

Operations for creating, managing, and pinging heartbeat monitors.

POST
/v2/heartbeats
Create heartbeat
createHeartbeat body → 201400401
GET
/v2/heartbeats
List heartbeats
listHeartbeats → 200401
GET
/v2/heartbeats/{name}
Get heartbeat
getHeartbeat 1 param → 200401404
PATCH
/v2/heartbeats/{name}
Update heartbeat
updateHeartbeat 1 param body → 200400401404
DELETE
/v2/heartbeats/{name}
Delete heartbeat
deleteHeartbeat 1 param → 200401404
GET
/v2/heartbeats/{name}/ping
Ping heartbeat
pingHeartbeat 1 param → 202401404
POST
/v2/heartbeats/{name}/enable
Enable heartbeat
enableHeartbeat 1 param → 200401404
POST
/v2/heartbeats/{name}/disable
Disable heartbeat
disableHeartbeat 1 param → 200401404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Heartbeat (11 properties), CreateHeartbeatRequest (9 properties), UpdateHeartbeatRequest (8 properties), SuccessResponse (3 properties). Each schema is shown below with its type and property counts.

HeartbeatResponse
object
3 properties
ErrorResponse
object
3 properties
ListHeartbeatsResponse
object
3 properties
Heartbeat
object
11 properties
CreateHeartbeatRequest
object
9 properties 4 required
UpdateHeartbeatRequest
object
8 properties
SuccessResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opsgenie-heartbeats-api-openapi.yml Raw ↑

Other APIs OpsGenie publishes across the network.

OpsGenie Account API
OpsGenie Alerts API
OpsGenie Escalations API
OpsGenie Incidents API
OpsGenie Integrations API
OpsGenie Maintenance API
OpsGenie Notification Rules API
OpsGenie On-Call API
OpsGenie Overrides API
OpsGenie Rotations API
OpsGenie Schedules API
OpsGenie Services API
Where this information came from

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