Web Service Method: Check whether UnifiedViews Container is Ready for Traffic

Path variables

JSON formatted response message and an HTTP status of 200 for success and 503 for failure.

Request pattern

http://<server-url>/master/api/1/health/readiness

Examples

Example Request without info parameter

http://example.org/master/api/1/health/readiness

Example Response

 
   "status": "UP"
}

Example Request with info parameter set to false (default value)

http://example.org/master/api/1/health/readiness&info=false

Example Response

 
   "status": "UP"
}

Example Request: with info parameter set to true, everything is up

http://example.org/master/api/1/health//readiness?info=true 

Example Response

{
    "status": "UP",
    "downstream": [
        {
            "name": "backend",
            "status": "UP"
        },
        {
            "name": "frontend",
            "status": "UP"
        },
        {
            "name": "rdf4j",
            "status": "UP"
        }
    ]
}

Example Request: with info parameter set to true, back end is down

http://example.org/master/api/1/health/readiness?info=true

Example Response

{
  "status": "DOWN",
  "downstream": [
    {
      "name": "backend",
      "status": "DOWN",
      "message": "Failed to reach backend probe."
    },
    {
      "name": "frontend",
      "status": "UP"
    },
    {
      "name": "rdf4j",
      "status": "UP"
    }
  ]
}