Skip to main content
Returns the current health status of the server. Use this endpoint to confirm the service is reachable before submitting IoCs, or as a liveness probe in your infrastructure. 
GET /api/health

​
Authentication

None required.

​
Request

No query parameters or request headers are needed. 
curl http://localhost:4321/api/health

​
Response

Status: 200 OK
Content-Type: application/json
​
status
string
required
Always "ok" when the server is healthy.
{ "status": "ok" }
This endpoint does not check the availability of upstream providers (VirusTotal, AbuseIPDB, PolySwarm, OpenRouter). A 200 response only confirms the CyberThreat AI server process itself is running.

Build docs developers (and LLMs) love

Get started for freeTalk to us