API Reference
System
The System API provides endpoints for checking the health and version of the Unsent API.
Base URL
https://api.unsent.dev/v1Overview
Use these endpoints to monitor the status of the Unsent API and retrieve version information for debugging or compatibility checks.
Features
Health Check
Monitor API uptime and status
Endpoints
Health Check
GET /v1/health
Check if the API is running correctly. This endpoint does not require authentication.
Example Request:
curl -X GET https://api.unsent.dev/v1/healthResponse (200 OK):
{
"status": "ok",
"uptime": 123456.78,
"timestamp": 1705315200000
}Get Version
GET /v1/version
Retrieve detailed API version and environment information.
Example Request:
curl -X GET https://api.unsent.dev/v1/versionResponse (200 OK):
{
"version": "1.0.0",
"environment": "production",
"nodeVersion": "v18.16.0",
"platform": "linux",
"arch": "x64",
"timestamp": "2024-01-15T10:00:00.000Z",
"versions": {
"node": "18.16.0",
"v8": "10.2.154.26-node.26"
},
"memory": {
"rss": 12345678,
"heapTotal": 5678901,
"heapUsed": 3456789,
"external": 123456
}
}