Skip to main content

Health Endpoint

Access health metrics via REST API.

Get All Package Health​

GET /api/health/packages

Response:

{
    "packages": [
        {
        "packageName": "package-name",
        "health": {
            "buildStatus": "success",
            "testCoverage": 0,
            "lintStatus": "unknown",
            "securityAudit": "unknown",
            "overallScore": 50
        },
        "isHealthy": false
        },
        ...
   ],
    "summary": {
    "total": 15,
    "healthy": 0,
    "unhealthy": 15,
    "averageScore": 42.33
    }
}

Refresh Health Data​

POST /api/health/refresh

Response:

{
    "packages": [
        {
        "packageName": "package-name",
        "health": {
            "buildStatus": "success",
            "testCoverage": 0,
            "lintStatus": "unknown",
            "securityAudit": "unknown",
            "overallScore": 50
        },
        "isHealthy": false
        },
        ...
   ],
    "summary": {
    "total": 15,
    "healthy": 0,
    "unhealthy": 15,
    "averageScore": 42.33
    }
}