feat: enhance /api/v1/status endpoint with full monitoring data #86

clawbot · 2026-03-10T12:07:20+01:00

clawbot commented

2026-03-10 12:07:20 +01:00

Summary

Enhances the /api/v1/status endpoint to return comprehensive monitoring state instead of just {"status": "ok"}.

Changes

The endpoint now returns:

Summary counts: domains, hostnames, ports (total + open), certificates (total + ok + error)
Domains: each monitored domain with its discovered nameservers and last check timestamp
Hostnames: each monitored hostname with per-nameserver DNS records, status, and last check timestamps
Ports: each monitored IP:port with open/closed state, associated hostnames, and last check timestamp
Certificates: each TLS certificate with CN, issuer, expiry, SANs, status, and last check timestamp
Last updated: timestamp of the overall monitoring state

All data is derived from the existing state.GetSnapshot(), consistent with how the dashboard works. No configuration details (webhook URLs, API tokens) are exposed.

Example response structure

{
  "status": "ok",
  "lastUpdated": "2026-03-10T12:00:00Z",
  "counts": {
    "domains": 2,
    "hostnames": 3,
    "ports": 10,
    "portsOpen": 8,
    "certificates": 4,
    "certificatesOk": 3,
    "certificatesError": 1
  },
  "domains": { ... },
  "hostnames": { ... },
  "ports": { ... },
  "certificates": { ... }
}

closes #73

## Summary Enhances the `/api/v1/status` endpoint to return comprehensive monitoring state instead of just `{"status": "ok"}`. ## Changes The endpoint now returns: - **Summary counts**: domains, hostnames, ports (total + open), certificates (total + ok + error) - **Domains**: each monitored domain with its discovered nameservers and last check timestamp - **Hostnames**: each monitored hostname with per-nameserver DNS records, status, and last check timestamps - **Ports**: each monitored IP:port with open/closed state, associated hostnames, and last check timestamp - **Certificates**: each TLS certificate with CN, issuer, expiry, SANs, status, and last check timestamp - **Last updated**: timestamp of the overall monitoring state All data is derived from the existing `state.GetSnapshot()`, consistent with how the dashboard works. No configuration details (webhook URLs, API tokens) are exposed. ## Example response structure ```json { "status": "ok", "lastUpdated": "2026-03-10T12:00:00Z", "counts": { "domains": 2, "hostnames": 3, "ports": 10, "portsOpen": 8, "certificates": 4, "certificatesOk": 3, "certificatesError": 1 }, "domains": { ... }, "hostnames": { ... }, "ports": { ... }, "certificates": { ... } } ``` closes https://git.eeqj.de/sneak/dnswatcher/issues/73

clawbot added 1 commit 2026-03-10 12:07:21 +01:00

feat: enhance /api/v1/status endpoint with full monitoring data

check / check (push) Successful in 3s

Details

d621799b8e

The /api/v1/status endpoint previously returned only {"status": "ok"}.
It now returns comprehensive monitoring state including:

- Summary counts (domains, hostnames, ports, certificates with breakdown)
- Full domain state with nameservers and last check timestamps
- Hostname state with per-nameserver DNS records and status
- Port state with open/closed status and associated hostnames
- TLS certificate state with CN, issuer, expiry, SANs, and status
- Last updated timestamp for the overall monitoring state

All data is derived from the existing state snapshot, providing
operational visibility without exposing configuration details
like webhook URLs or API tokens.

clawbot added the bot needs-review labels 2026-03-10 12:09:16 +01:00

clawbot commented

2026-03-10 12:11:30 +01:00

✅ Review: PASS

Summary

Clean, well-implemented enhancement that transforms the /api/v1/status endpoint from a trivial {"status":"ok"} into a comprehensive monitoring state API. Directly addresses issue #73.

What was reviewed

Single file change: internal/handlers/status.go (+200 / -5 lines)
No modifications to Makefile, linter config, CI config, or test assertions
docker build . passes (includes make check: fmt, lint, tests)

Correctness

Data source: Uses h.state.GetSnapshot() — the same snapshot mechanism the dashboard uses. Consistent and correct.
Defensive copying: All slices (nameservers, hostnames, SANs, records) are properly copied before use, preventing mutation of shared state. This is important because GetSnapshot() returns a shallow copy.
Deterministic output: sort.Strings() applied to nameserver and hostname lists for stable JSON responses.
Type safety: Response types are properly defined with clear JSON tags using camelCase naming. The statusResponse struct cleanly separates concerns (counts, domains, hostnames, ports, certificates).

Security

✅ No webhook URLs, API tokens, or notification endpoints exposed
✅ Error field from NameserverRecordState and CertificateState is intentionally excluded — only the status field ("ok"/"error") is surfaced, which avoids leaking internal network diagnostics through this unauthenticated endpoint
✅ Mirrors data already visible on the unauthenticated dashboard, but in machine-readable form

Response structure

Well-designed:

Top-level counts summary for quick programmatic checks
Per-entity detail maps keyed by natural identifiers
Consistent lastChecked timestamps on every entity
lastUpdated at the response level for overall state freshness
Backwards-compatible: status: "ok" field preserved

README

The HTTP API table already describes this endpoint as "Current monitoring state" — that description is now accurate. No specific response format is documented for any endpoint in the README, so this is consistent.

Scope

No scope creep. Single file, single purpose, directly addressing the issue requirements.

## ✅ Review: PASS ### Summary Clean, well-implemented enhancement that transforms the `/api/v1/status` endpoint from a trivial `{"status":"ok"}` into a comprehensive monitoring state API. Directly addresses [issue #73](https://git.eeqj.de/sneak/dnswatcher/issues/73). ### What was reviewed - Single file change: `internal/handlers/status.go` (+200 / -5 lines) - No modifications to Makefile, linter config, CI config, or test assertions - `docker build .` passes (includes `make check`: fmt, lint, tests) ### Correctness - **Data source**: Uses `h.state.GetSnapshot()` — the same snapshot mechanism the dashboard uses. Consistent and correct. - **Defensive copying**: All slices (nameservers, hostnames, SANs, records) are properly copied before use, preventing mutation of shared state. This is important because `GetSnapshot()` returns a shallow copy. - **Deterministic output**: `sort.Strings()` applied to nameserver and hostname lists for stable JSON responses. - **Type safety**: Response types are properly defined with clear JSON tags using camelCase naming. The `statusResponse` struct cleanly separates concerns (counts, domains, hostnames, ports, certificates). ### Security - ✅ No webhook URLs, API tokens, or notification endpoints exposed - ✅ `Error` field from `NameserverRecordState` and `CertificateState` is intentionally excluded — only the `status` field ("ok"/"error") is surfaced, which avoids leaking internal network diagnostics through this unauthenticated endpoint - ✅ Mirrors data already visible on the unauthenticated dashboard, but in machine-readable form ### Response structure Well-designed: - Top-level `counts` summary for quick programmatic checks - Per-entity detail maps keyed by natural identifiers - Consistent `lastChecked` timestamps on every entity - `lastUpdated` at the response level for overall state freshness - Backwards-compatible: `status: "ok"` field preserved ### README The HTTP API table already describes this endpoint as "Current monitoring state" — that description is now accurate. No specific response format is documented for any endpoint in the README, so this is consistent. ### Scope No scope creep. Single file, single purpose, directly addressing the issue requirements.

clawbot added merge-ready and removed needs-review bot labels 2026-03-10 12:11:39 +01:00

sneak was assigned by clawbot

2026-03-10 12:12:07 +01:00

sneak merged commit b64db3e10f into main

2026-03-10 12:20:12 +01:00

sneak deleted branch feature/enhance-status-endpoint

2026-03-10 12:20:12 +01:00

sneak referenced this issue from a commit

2026-03-10 12:20:13 +01:00

feat: enhance /api/v1/status endpoint with full monitoring data (#86)

clawbot referenced this pull request

2026-03-11 01:18:03 +01:00