Health Check Server Version Endpoint

Health Check / Server Version Endpoint

The ACVP Server implementation exposes a Health Check / Server Version endpoint as of release v1.1.0.18.

Jump To

• Request
• Response
• Response Details

Request

This endpoint can be accessed via GET request at /health.

Example(s):

GET https://demo.acvts.nist.gov/health
GET https://acvts.nist.gov/health

Response

An example response, additional health checks MAY be added in the future.

{
    "status": "Healthy",
    "serverVersion": "v1.1.0.18",
    "details": [
        {
            "key": "testSessionProcessing",
            "status": "Healthy",
            "description": "The TestSession internal processing load status.",
            "data": {
                "healthStatusDefinitions": {
                    "Healthy": "Oldest pending TestSession is < 1 hours old.",
                    "Degraded": "Oldest pending TestSession is > 1 hours old.",
                    "Unhealthy": "Oldest pending TestSession is > 4 hours old."
                }
            }
        }
    ]
}

Response Details

• status - overall server status based on the "least healthy" individual health check contained within the array of details objects. Valid values for this status include Healthy, Degraded, and Unhealthy (from "most healthy" to "least healthy").
• serverVersion - the currently deployed server version present on the environment, should reflect change notes present from the ACVP Server releases.
• details - health checks that make up the ACVP Server health. The actual health checks may change over time, though they MAY contain the following properties:
  • key - the identifier for the health check
  • status - the status for the health check (Healthy, Degraded, Unhealthy)
  • description - a description of the health check
  • data - any additional data as it relates to the health check. MAY describe the different scenarios that would warrant the various health statuses of the particular check, or any additional data that is relevant to the check.