Dashboard and API Quick Usage

Quick operational guide for using the AutoDoctor dashboard and API endpoints for monitoring, scripting, validation workflows, and summary-driven automation.
Categories:
Tags:

Who This Is For

  • Technical users validating deployment health.
  • Script authors integrating AutoDoctor outputs.

Base URL

Default local base URL:

http://127.0.0.1:8000

Primary Endpoints

  • GET /health
  • GET /api/system/latest
  • GET /api/system/history
  • GET /api/alerts
  • GET /api/health
  • GET /api/modules
  • GET /api/dashboard/meta
  • GET /api/dashboard/summary

PowerShell Examples 

Invoke-RestMethod http://127.0.0.1:8000/health
Invoke-RestMethod http://127.0.0.1:8000/api/system/latest
Invoke-RestMethod http://127.0.0.1:8000/api/alerts
Invoke-RestMethod http://127.0.0.1:8000/api/dashboard/meta
Invoke-RestMethod http://127.0.0.1:8000/api/dashboard/summary

When to Use Which Endpoint

  • Use /health for simple liveness checks.
  • Use /api/system/latest and /api/system/history for metric pipelines.
  • Use /api/dashboard/meta to confirm the latest run was written.
  • Use /api/dashboard/summary when you want one payload that already includes health display, main concern, metric states, and grouped findings.

Optional API Key Security

If AUTO_DOCTOR_API_KEY is set, include header:

$headers = @{ "X-AutoDoctor-Key" = "your-secret" }
Invoke-RestMethod http://127.0.0.1:8000/api/system/latest -Headers $headers

Dashboard Query Override

You can force dashboard API target with query parameter:

http://127.0.0.1:8000/dashboard/?api_base=http://127.0.0.1:8000

Useful in proxy or split-host debugging.

Next Steps