Dashboard and API Quick Usage
Quick operational guide for using the AutoDoctor dashboard and API endpoints for monitoring, scripting, and validation workflows.
Categories:
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 /healthGET /api/system/latestGET /api/system/historyGET /api/alertsGET /api/healthGET /api/modulesGET /api/dashboard/meta
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
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
- Full endpoint details: API Reference
- If endpoint calls fail: Troubleshooting Playbook