Other
/api/v1/website-health-checkPacketFlo Website Health Check API
DNS, ping, HTTP, SSL, and port checks against a domain in one pass, with a plain verdict.
| Parameter | Type | Required | Description |
|---|---|---|---|
target | string | Yes | Domain or URL to check. |
Example request
curl "https://packetflo.io/api/v1/website-health-check?target=example.com&api_key=YOUR_API_KEY"
Example response
{ "ok": true, "data": { "domain": "example.com", "targetUrl": "https://example.com/", "ip": "172.66.147.243", "verdict": { "status": "warning", "headline": "Mostly healthy", "summary": "Worth a look: Security headers." }, "checks": [ { "id": "dns", "label": "IP address", "status": "ok", "summary": "172.66.147.243", "details": { "ip": "172.66.147.243", "addresses": ["172.66.147.243", "2001:db8::1"] } }, { "id": "location", "label": "Location", "status": "ok", "summary": "United States", "details": { "countryCode": "US" } }, { "id": "organization", "label": "Organization", "status": "ok", "summary": "Cloudflare, Inc.", "details": { "orgDomain": "cloudflare.com" } }, { "id": "ping", "label": "Ping", "status": "ok", "summary": "32ms average round trip, no packet loss.", "details": { "avgRoundTripMs": 32, "packetLossPercent": 0 } }, { "id": "latency", "label": "Latency", "status": "ok", "summary": "119ms response time.", "details": { "totalMs": 119, "breakdown": { "dnsMs": 11, "tcpMs": 20, "tlsMs": 53, "remainingMs": 35, "totalMs": 119 } } }, { "id": "http", "label": "HTTP response", "status": "ok", "summary": "Server returned 200 OK.", "details": { "statusCode": 200, "statusText": "OK", "cloudflareBlocked": false } }, { "id": "redirects", "label": "Redirects", "status": "ok", "summary": "No redirects — this is the final destination.", "details": { "hops": [] } }, { "id": "ssl", "label": "SSL certificate", "status": "ok", "summary": "Valid — 46 days remaining.", "details": { "daysRemaining": 46, "percentRemaining": 13, "addresses": [{ "ip": "172.66.147.243", "status": "ok", "summary": "Valid — 46 days remaining." }, { "ip": "2001:db8::1", "status": "ok", "summary": "Valid — 46 days remaining." }] } }, { "id": "security", "label": "Security headers", "status": "warning", "summary": "0/5 common security headers present.", "details": { "present": 0, "total": 5 } }, { "id": "protocol", "label": "HTTP protocol", "status": "ok", "summary": "HTTP/2 negotiated.", "details": { "protocol": "HTTP/2" } }, { "id": "compression", "label": "Compression", "status": "ok", "summary": "Brotli enabled.", "details": { "encoding": "br" } }, { "id": "ports", "label": "Ports (80 / 443)", "status": "ok", "summary": "HTTP (80): Open · HTTPS (443): Open", "details": { "addresses": [{ "ip": "172.66.147.243", "http": "Open", "https": "Open" }, { "ip": "2001:db8::1", "http": "Open", "https": "Open" }], "ports": [{ "port": 80, "protocol": "http", "status": "open" }, { "port": 443, "protocol": "https", "status": "open" }] } } ] }, "meta": { "tool": "website-health-check", "version": "v1" } }
Reading the result
Use verdict for a summary, then inspect each check's ok, warning or critical status. One failed ICMP check does not by itself prove the website is down.
Response fields
| Field | What it tells you |
|---|---|
domain / targetUrl / ip | Checked host, target URL and selected primary address. |
verdict | Overall status, headline and summary of findings. |
checks | DNS, location, organization, ping, latency, HTTP, redirects, SSL, security headers, protocol, compression and ports. |
DNS details.addresses | All resolved A and AAAA addresses. IPv6 addresses contain a colon; the top-level ip is the selected primary address. |
SSL / ports details.addresses | Per-address SSL and port findings include IPv4 and IPv6 when published and testable. An IPv6 routing failure from PacketFlo can leave SSL unverified. |
checks[].details | Other check-specific values include HTTP status, packet loss, certificate lifetime and redirects. Unavailable measurements can be null; inspect status and summary alongside them. |
Scope and limits
Runs from PacketFlo's server and preserves the target URL's path and query. Ping and location use the primary address; HTTP follows normal address selection and is not separately probed over IPv6. Port checks cover 80 and 443 across a bounded address sample that includes each published family. TLS inspection follows the HTTPS target port. It is not a worldwide outage test or a browser page-load benchmark.
Authentication and errors
Send your key in the x-api-key header, or the supported api_key query parameter. Each request uses 5 credits from the key's shared 300-credit rolling 24-hour budget. Credits are charged before parameter validation. Successful responses and quota errors include usage headers; GET and OPTIONS support CORS.
| API status | Meaning |
|---|---|
200 | The diagnostic returned a result in data, with ok: true and version information in meta. Read the diagnostic fields to determine the target's condition. |
400 | Invalid or blocked input, or a lookup/check failure that could not be returned as a diagnostic result. Read error for details. |
401 | Missing, invalid or revoked API key. |
429 | The request would exceed the key's available credit budget. |