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 Outages API

On-call outage acknowledgement, resolution, and escalation.

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

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

This API exposes 8 operations across 6 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.

8 operations 6 paths 2 schemas 1 DELETE2 GET5 POST

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 Outages 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 8

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

Outages 8

On-call outage acknowledgement, resolution, and escalation.

GET
/outages
List all outages
listOutages → 200
POST
/outages
Create a manual outage
createOutage body → 201
GET
/outages/{outage_uuid}
Retrieve an outage
getOutage 1 param → 200
DELETE
/outages/{outage_uuid}
Delete a manual outage
deleteOutage 1 param → 204
POST
/outages/{outage_uuid}/acknowledge
Acknowledge an outage
acknowledgeOutage 1 param → 200
POST
/outages/{outage_uuid}/unacknowledge
Remove acknowledgement from an outage
unacknowledgeOutage 1 param → 200
POST
/outages/{outage_uuid}/resolve
Resolve an outage
resolveOutage 1 param → 200
POST
/outages/{outage_uuid}/escalate
Escalate an outage to team members
escalateOutage 1 param → 200

Schemas 2

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

OutageInput
object
3 properties
Outage
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hyperping-outages-api-openapi.yml Raw ↑

Other APIs Hyperping publishes across the network.

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