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

Scheduled maintenance windows.

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

Tagged areas include Maintenance. 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 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.

6 operations 3 paths 2 schemas 1 DELETE2 GET2 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 Maintenance 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 6

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

Maintenance 6

Scheduled maintenance windows.

GET
/maintenance-windows
List all maintenance windows
listMaintenanceWindows → 200
POST
/maintenance-windows
Create a maintenance window
createMaintenanceWindow body → 201
GET
/maintenance-windows/{maintenance_uuid}
Retrieve a maintenance window
getMaintenanceWindow 1 param → 200
PUT
/maintenance-windows/{maintenance_uuid}
Update a maintenance window
updateMaintenanceWindow 1 param body → 200
DELETE
/maintenance-windows/{maintenance_uuid}
Delete a maintenance window
deleteMaintenanceWindow 1 param → 204
POST
/maintenance-windows/{maintenance_uuid}/complete
Mark a maintenance window as completed
completeMaintenanceWindow 1 param → 200

Schemas 2

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

MaintenanceWindow
object
7 properties
MaintenanceWindowInput
object
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hyperping-maintenance-api-openapi.yml Raw ↑

Other APIs Hyperping publishes across the network.

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