title: System Routes
description: Built-in introspection routes in JustAPI — help, tools, OpenAPI, health checks.
keywords: [JustAPI, system routes, health check, help, introspection, tools]

Built-in Routes

JustAPI registers these routes automatically:

Enable System Routes

app = JustAPIApp(admin_token="my-secret-token")
app.enable_system_routes()

This mounts additional introspection routes:

Register Health Checks

def check_db():
    db = app.db
    if db.health():
        return True
    raise Exception("Database unreachable")

def check_redis():
    # Check Redis connection
    return True

app.register_health_check("database", check_db)
app.register_health_check("redis", check_redis)

GET /ready returns 200 only if all health checks pass.

Admin Token Protection

Routes like /metrics, /openapi.json, /docs are protected by admin_token:

app = JustAPIApp(admin_token="my-secret-token")

Include the token in requests:

curl -H "Authorization: Bearer my-secret-token" http://localhost:8000/metrics

See Also

• Health Checks — monitoring
• Metrics & Monitoring — Prometheus
• Configuration Reference — all options