canonical: https://jentic.com/apis/hyperping.io/hyperping

# Hyperping API

The Hyperping API, served from api.hyperping.io, runs a project's uptime checks and the public status pages that report them. Status page calls create and restyle pages with a subdomain or custom hostname, theme, languages, and sections, and incident calls publish outages or incidents on those pages with localized titles and a timeline of investigating, identified, monitoring, and resolved updates. Behind the page, the API manages HTTP, port, and ICMP monitors, cron healthchecks with ping URLs and grace periods, and detected outages with acknowledge, escalate, and resolve actions. Maintenance windows silence alerts during planned work, and per-monitor reports return SLA and MTTR figures.

## For AI agents

Publish and update Hyperping status page incidents, build and restyle status pages, schedule maintenance windows, manage uptime monitors and cron healthchecks, and act on detected outages.

## Scope

Does not send customer email or SMS campaigns, host a help center, or store application logs and traces. Use for Hyperping status pages, incidents, maintenance windows, monitors, healthchecks, and outage handling only.

## Capabilities

- Create a status page with a subdomain or custom hostname, theme, accent colour, languages, and logo
- Publish an outage or incident on one or more status pages with affected components
- Add investigating, identified, monitoring, or resolved updates to an incident's public timeline
- Schedule maintenance windows for chosen monitors and status pages with advance notification settings
- Monitor HTTP endpoints, ports, or hosts over ICMP from selected probe regions
- Watch cron jobs with healthchecks that alert when a ping does not arrive within the grace period
- Resolve, escalate, or acknowledge detected outages and read SLA and MTTR per monitor

## Use cases

### Status page communication by an agent through Jentic

A developer's agent keeps the public status page current during an incident: it opens the incident, then adds timeline updates as the team reports progress. Through Jentic it finds the incident operations by intent, the Hyperping key is injected by the developer's own Jentic One instance, and a rule can pin it to one incident id so it cannot edit other incidents or the page settings.

Example prompt: Call POST `/v3/incidents` with type incident, a title of 'Payments degraded', and the public status page id in statuspages, then call POST `/v3/incidents/{uuid}/updates` with type monitoring and text 'A fix is deployed and we are watching error rates'

### Planned maintenance notices

Announce planned work and keep it from paging anyone. A maintenance window needs a name, start_date, end_date, and the monitors it covers, and can also list status pages, a public title and updates, and notification settings through notificationOption and notificationMinutes.

Example prompt: Call POST `/v1/maintenance-windows` with name 'Database upgrade', start_date 2026-11-07T02:00:00Z, end_date 2026-11-07T04:00:00Z, the two API monitor ids in monitors, and the public status page id in statuspages

### Launch a branded status page

Stand up a status page for a new product. The create call takes a name and a subdomain or hostname plus branding such as theme, font, accent_color, logo, and favicon; the spec notes the page is public as soon as it exists unless authentication is set, so set that first if it should stay private.

Example prompt: Call POST `/v2/statuspages` with name 'Acme Status', subdomain acme-status, hostname status.acme.com, accent_color #4F46E5, and theme light, then read it back with GET `/v2/statuspages/{uuid}`

### Outage cleanup and follow-up

Close the loop after an incident. List outages filtered to resolved or ongoing and by manual or monitor type, resolve any left open, and pull the affected monitor's report for SLA and MTTR to include in the post-incident review.

Example prompt: Call GET `/v2/outages` with status ongoing, POST `/v2/outages/{uuid}/resolve` for each one the team confirmed fixed, then GET `/v2/reporting/monitor-reports/{uuid}` for the affected monitor

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/v3/incidents` | Create a status page incident |
| POST | `/v3/incidents/{uuid}/updates` | Add an incident timeline update |
| PUT | `/v3/incidents/{uuid}` | Update an incident |
| POST | `/v2/statuspages` | Create a status page |
| PUT | `/v2/statuspages/{uuid}` | Update a status page |
| POST | `/v1/maintenance-windows` | Schedule a maintenance window |
| GET | `/v2/outages` | List detected outages |
| POST | `/v1/healthchecks` | Create a cron healthcheck |

## Key resources

- **Status pages** — Public pages with subdomain or hostname, theme, languages, branding, and sections
- **Incidents** — Status page outages or incidents with affected components and a public update timeline
- **Maintenance windows** — Planned work windows tied to monitors and status pages, with notification settings
- **Monitors and healthchecks** — Uptime checks by protocol and region, and cron heartbeats with ping URLs
- **Outages** — Detected or manual incidents that can be acknowledged, escalated, or resolved
- **Reports** — Per-monitor SLA, MTTR, and outage history

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 66 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 89 / 100
  - Developer Experience & Jentic Compatibility: 61 / 100
  - AI-Readiness & Agent Experience: 50 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 73 / 100
- **View full report:** https://jentic.com/apis/hyperping.io/hyperping/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Hyperping API by hand means issuing a project key, sending it as a bearer token to api.hyperping.io, and learning that status page incidents sit under /v3 while status pages and outages sit under /v2 and monitors under /v1. Through Jentic you install once, import Hyperping from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Hyperping puts the incident, status page, and monitor id in the URL path (`/v3/incidents/{uuid}`, `/v2/statuspages/{uuid}`), so a rule can pin your agent to one incident or one status page. You choose the operations it may call, so deleting incidents, status pages, or monitors is not included unless you add it.
- **Credential handling:** Your Hyperping API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'post a status page update' or 'schedule maintenance', and Jentic returns the matching Hyperping operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Statuspage API** — Atlassian's hosted status pages and incident communication
- **Instatus API** — Hosted status pages with incidents and maintenance
- **Cronitor API** — Cron job and heartbeat monitoring
- **Opsgenie API** — Alerting and on-call management

## FAQ

### What authentication does the Hyperping API use?

The Hyperping OpenAPI spec declares HTTP bearer authentication. You create the API key on your project's developers page in the Hyperping app and send it in the Authorization header to api.hyperping.io. With Jentic, your own Jentic One instance keeps the key encrypted and adds it to each call, so the agent does not hold it.

### How do I post updates to a Hyperping status page incident?

Create the incident with POST `/v3/incidents`, giving a title and a type of outage or incident, then add timeline entries with POST `/v3/incidents/{uuid}/updates.` Each update carries a date, localized text, and a type of investigating, identified, update, monitoring, or resolved.

### Is a new Hyperping status page public straight away?

Yes, according to the spec: POST `/v2/statuspages` creates a page that is public as soon as it exists, unless authentication is set. When editing later, note that sending sections in PUT `/v2/statuspages/{uuid}` replaces every section, so start from the GET response.

### What are the rate limits for the Hyperping API?

Rate limits are not stated in the Hyperping OpenAPI spec. Check Hyperping's documentation at https://hyperping.com for the current limits on your plan.

### How do I schedule maintenance with the Hyperping API through Jentic?

Search Jentic for 'schedule a maintenance window' to get POST `/v1/maintenance-windows`, then send the required name, start_date, end_date, and monitors, plus statuspages if the notice should appear publicly. To run it on your own infrastructure, install Jentic One from its GitHub repo and store your Hyperping key once.

### Is there a Hyperping MCP server?

You don't need an MCP server to give your agent Hyperping. Jentic connects it directly from the API Directory: import it, store your key once, and your agent reaches the incident, status page, and monitor operations you allow without extra tool definitions in its context.

### Can I limit what my agent is allowed to do with the Hyperping API?

Yes. For example, allow only POST `/v3/incidents/{uuid}/updates` and PUT `/v3/incidents/{uuid}` for the open incident's id, so the agent can post progress and resolve that one incident but cannot create new ones, change status page settings, or delete monitors. Your Jentic One instance logs the calls it makes.