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.

Docs API Reference

Skip to navigation

Check the status of the API

||View as Markdown|

GET

///v1/status

GET

/v1/status

curl /v1/status \
     -H "Content-Type: application/json"

{
  "status": "ok",
  "timestamp": "2024-01-15T09:30:00Z",
  "uptime": 842763.5,
  "version": "0.1.0",
  "environment": "production",
  "system": {
    "memory": {
      "rssMb": 128.4,
      "heapUsedMb": 74.2,
      "heapTotalMb": 96
    },
    "cpuLoadPercentage": 23.7
  }
}

Response

OK

statusenum

Allowed values:

timestampdatetime

uptimedouble>=0

versionstring

environmentenum

Allowed values:

systemobjectOptional

Errors

404

Not Found Error

Was this page helpful?

API Root Banner

Filter an image

Docs API Reference

Overview
- API reference
Aegis