Developer

Network Diagnostics API: A Developer's Guide

A practical guide to building diagnostics workflows on top of an operational API — what to monitor programmatically, how to design the integration, and how to roll it out without alert fatigue.

Why programmatic diagnostics matter

Dashboards are great for ad-hoc investigation, but production reliability lives in automation. A diagnostics API lets you treat DNS, SSL, uptime, latency, and reputation checks as first-class signals inside your own product — embedded in customer dashboards, wired into incident workflows, and replayable from CI/CD.

The endpoints you'll integrate first

/v1/uptime — HTTPS reachability, status code, latency, optional multi-region.
/v1/dns — A/AAAA/MX/TXT/NS/CNAME via DNS-over-HTTPS.
/v1/ssl — issuer, chain, expiry, handshake timing.
/v1/blacklist — IP / domain reputation across major lists.
/v1/latency — endpoint timing samples with jitter.
/v1/packet-loss — connection-quality sampling for gaming, streaming, VOIP.

Designing an integration that doesn't burn out your team

Start with one signal — usually uptime — wired into a single channel (Slack, email).
Require N consecutive failures before alerting; transient blips create alert fatigue and erode trust.
Wire SSL expiry warnings weeks ahead, not hours. The cost of being early is zero; the cost of being late is an outage.
Tag every diagnostic with the customer / service it relates to. Untagged alerts get ignored.
Send incident open AND close events; one-sided feeds make on-call worse.

Where the diagnostics API fits in your stack

The API is intentionally narrow: stateless probes plus scheduled monitors with webhook fan-out. It does not try to replace your APM, your logging, or your status page — it feeds them. Most teams start by piping uptime + SSL + DNS results into the systems they already have, then layer reputation and packet-loss checks as their product matures.

Recommended next steps

Diagnostic workflow

1
Join the API waitlist
Indicate which endpoints you'd integrate first so we can prioritize.
Open waitlist
2
Prototype the workflow in the dashboard
Every API endpoint mirrors an existing in-dashboard tool — wire the workflow now.
Configure monitors
3
Map endpoints to current monitors
Decide which scheduled checks you'd want to drive programmatically.
Developer workspace
4
Read the white-label reporting guide
Combining the API with branded reports is the common SaaS pattern.
White-label guide

Frequently asked questions

When will the API be available?

We're onboarding developers in small batches from the waitlist. Joining lets you indicate which endpoints you'd use first so we prioritize correctly.

What endpoints are planned?

DNS lookup, SSL/TLS validation, uptime/reachability, blacklist & reputation, latency timing, packet-loss sampling, VPN-leak detection, and streaming readiness — all REST + JSON.

Will there be webhooks?

Yes. Webhook callbacks on incident open/close, SSL expiry warnings, blacklist listings, and scheduled-monitor state changes — so you can wire diagnostics into PagerDuty, Slack, or internal queues.

How is auth handled?

Bearer tokens scoped per workspace. Keys can be rotated, scoped to read or write, and audit-logged. Team plans get multiple keys with per-key rate limits.

What's the rate limit going to look like?

Tiered by plan — free developer keys get a small allowance for prototyping; paid plans scale to high-volume monitoring. Webhook deliveries don't count against API quota.

Can I use it for client work?

Yes. The API is designed for SaaS embeds and agency dashboards. Combined with white-label reporting, you can wrap diagnostics into your own product UI.