Skip to main content

Public Endpoints

These endpoints require no authentication and are safe to call from monitoring tools, status pages, uptime checkers, and public-facing dashboards.

Health Check​

GET https://api.indreelforge.com/api/health

Returns the operational status of the API server and its critical dependencies. Responds with HTTP 200 when fully healthy and 503 when a dependency (currently the database) is unavailable.

Used by load balancers, uptime monitors, and PM2 health checks.

curl https://api.indreelforge.com/api/health

Response — healthy​

{
  "status": "ok",
  "timestamp": "2025-06-01T10:00:00.000Z",
  "checks": {
    "api": "ok",
    "db": "ok",
    "uptime_s": 86400
  },
  "version": "1.0.0"
}

Response — degraded (HTTP 503)​

{
  "status": "degraded",
  "timestamp": "2025-06-01T10:00:00.000Z",
  "checks": {
    "api": "ok",
    "db": "error",
    "uptime_s": 3600
  },
  "version": "1.0.0"
}
FieldDescription
status"ok" or "degraded"
checks.apiAlways "ok" if the server is responding
checks.db"ok" if the database query succeeded, "error" otherwise
checks.uptime_sProcess uptime in seconds
versionAPI server version from package.json

Service Status​

GET https://api.indreelforge.com/api/status

Returns detailed service status and real-time upload success metrics for the last 24 hours. Suitable for powering a public status page.

curl https://api.indreelforge.com/api/status

Response​

{
  "status": "operational",
  "timestamp": "2025-06-01T10:00:00.000Z",
  "services": {
    "api_server": {
      "status": "operational",
      "response_time": "23ms"
    },
    "database": {
      "status": "operational"
    },
    "upload_processing": {
      "status": "operational"
    },
    "scheduler": {
      "status": "operational"
    },
    "oauth_connections": {
      "status": "operational"
    },
    "ffmpeg_processing": {
      "status": "operational"
    },
    "webhook_delivery": {
      "status": "operational"
    }
  },
  "metrics": {
    "upload_success_rate_24h": "99.12%",
    "total_uploads_24h": 1148,
    "failed_uploads_24h": 10
  },
  "uptime": "99.9%"
}

Overall Status Values​

ValueCondition
"operational"Database reachable and upload success rate > 95% in the last 24 hours
"degraded"Upload success rate is between 80% and 95%
"outage"Database unreachable or upload success rate is below 80%

Service Status Values​

Each entry in services reports one of:

ValueMeaning
"operational"Service is functioning normally
"degraded"Service is impaired but partially functioning
"unknown"Status could not be determined (e.g. database connectivity lost)

Public Platform Stats​

GET https://api.indreelforge.com/api/stats

Returns aggregate platform statistics — total registered users, total uploads processed, and the number of supported social platforms. Intended for marketing pages and public dashboards.

curl https://api.indreelforge.com/api/stats

Response​

{
  "total_users": 8312,
  "total_uploads": 241500,
  "platforms": 11
}
FieldDescription
total_usersTotal number of registered IndReelForge accounts
total_uploadsTotal uploads processed across all users and platforms
platformsNumber of supported social platforms