For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

API Reference

Scan a file
Scan multiple files
Check process liveness
Check service readiness
List scans
Get a scan

API Reference Health

Check process liveness

GET

https://api.detectant.com/health/live

GET

/health/live

$ curl https://api.detectant.com/health/live

200Retrieved

1 {
2   "status": "ok"
3 }

Returns successfully while the API process can serve requests.

Response

The API process is live.

statusenum

Was this page helpful?

Check service readiness