API-key-protected monitoring outputs for controlled integrations
UptimeSure exposes JSON, SVG badge and HTML widget output endpoints protected by X-API-Key. Because ordinary img, iframe and script tags cannot attach that header, these outputs are for server-mediated integrations, trusted proxies, or clients that can explicitly send request headers; they are not copy-paste public embeds.
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, SVG badge or HTML widget responses behind a server-mediated integration or another client that can send X-API-Key. Do not place a raw API key in browser-visible markup or URLs.
What UptimeSure checks
- Read scope
- API-key validity
- Per-key rate limit
- Exact browser Origin policy
- Monitor public ID
Common use cases
- Server-side monitor status integration
- Trusted internal clients that can send X-API-Key
- Proxy-rendered status badge
- Proxy-rendered status widget
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 scoped API key for a trusted integration service, send it in X-API-Key from that service, and proxy only the intended monitor output to viewers.
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 has one generic badge and one generic HTML widget output; both remain API-key-protected and require a header-capable or server-mediated client.
Explore UptimeSure
Start monitoring
Sign in to configure this monitor type and connect the alerts your account uses.