#
RPC health
This RPC checks if UniConfig is running. If database persistence is enabled, it also checks the database connection.
#
RPC examples
RPC input is empty. RPC output contains the result of the operation.
RPC Request
curl --location --request POST 'http://localhost:8181/rests/operations/uniconfig-manager:health' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Response if database persistence is enabled and the database connection is valid:
RPC Response, Status: 200
{
"output": {
"status": "UP",
"details": {
"state": "ACCEPTING_TRAFFIC",
"reason": "The application is ready to receive traffic and DB connection is alive"
}
}
}
Response if database persistence is enabled and database connection is not valid:
RPC Response, Status: 200
{
"output": {
"status": "DOWN",
"details": {
"state": "ACCEPTING_TRAFFIC",
"reason": "Error connecting to DB"
}
}
}