A small public monitoring API for health data and simple embeds
UptimeSure exposes a focused consumer API for reading a monitor by public ID and rendering a generic SVG badge or HTML widget. V1 requires an API key and deliberately does not claim the historical ranking, by-domain discovery or multiple badge/embed variants.
API keys are account-owned credentials stored as hashes. Each key has a name, rate limit and optional exact browser-origin allowlist. The raw key is shown once at creation.
Invalid/revoked keys, disallowed origins and exceeded rate limits are rejected instead of falling through to public data.
Use JSON for application integrations, the SVG badge for a compact status display, or the generic HTML widget for a simple embedded view.
What UptimeSure checks
- Read scope
- API-key validity
- Per-key rate limit
- Exact browser Origin policy
- Monitor public ID
Common use cases
- Internal portal health cards
- Documentation status badge
- Simple service status widget
- Server-side monitor status integration
Configuration
- API-key name
- Allowed origins when browser access is required
- Per-minute rate limit
- Monitor public ID
Alerts and recovery
The API is read-only for public monitor data; alert delivery is configured separately in the authenticated product.
Example
Example: create one API key for a documentation site origin, then use it to fetch the selected monitor JSON or SVG badge endpoint.
Frequently asked questions
Is the raw API key stored in the database?
No. V1 stores a hash and prefix; the raw key is shown only when created.
Does V1 include public ranking or domain discovery?
No. Those historical target routes are not V1 product claims.
Are there three different badge endpoints?
No. V1 documents the generic badge and generic HTML widget that actually exist.
Explore UptimeSure
Start monitoring
Sign in to configure this monitor type and connect the alerts your account uses.