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

Hyperping Healthchecks API

Cron-style monitors that expect periodic pings from scheduled tasks.

Hyperping Healthchecks API is one of 7 APIs that Hyperping publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Healthchecks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 7 operations across 4 paths, and defines 2 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://api.hyperping.io/v1.

7 operations 4 paths 2 schemas 1 DELETE2 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.hyperping.io/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

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

  • bearerAuth — Project API key issued from the Developers tab in project settings, sent as Authorization: Bearer $USERAPIKEY. Keys can be Read & Write or Read-only. A missing…

Paths & Operations 7

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

Healthchecks 7

Cron-style monitors that expect periodic pings from scheduled tasks.

GET
/healthchecks
List all healthchecks
listHealthchecks → 200
POST
/healthchecks
Create a new healthcheck
createHealthcheck body → 201
GET
/healthchecks/{healthcheck_uuid}
Retrieve a healthcheck
getHealthcheck 1 param → 200
PUT
/healthchecks/{healthcheck_uuid}
Update a healthcheck
updateHealthcheck 1 param body → 200
DELETE
/healthchecks/{healthcheck_uuid}
Delete a healthcheck
deleteHealthcheck 1 param → 204
POST
/healthchecks/{healthcheck_uuid}/pause
Pause a healthcheck
pauseHealthcheck 1 param → 200
POST
/healthchecks/{healthcheck_uuid}/resume
Resume a healthcheck
resumeHealthcheck 1 param → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Healthcheck (7 properties), HealthcheckInput (3 properties). Each schema is shown below with its type and property counts.

Healthcheck
object
7 properties
HealthcheckInput
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hyperping-healthchecks-api-openapi.yml Raw ↑

Other APIs Hyperping publishes across the network.

Hyperping Incidents API
Hyperping Maintenance API
Hyperping Monitors API
Hyperping Outages API
Hyperping Reports API
Hyperping Status Pages API