Health Status Readiness
A REST endpoint for retrieving server readiness health status calculated on its health components (DB, authentication and etc.).
Request
URI
GET
https://{api_host}/vco/api/health/readiness
COPY
Responses
200
The request is successful.
Returns
NodeStatusInfo
of type(s)
application/json
{
"serverState": "string",
"health-status": {
"healthStatus": "string",
"description": "string",
"time": 0,
"health-status-providers": [
{
"state": "string",
"name": "string",
"descritpion": "string",
"message": "string",
"critical": false
}
]
},
"instance-id": "string",
"local-configuration-descriptor": "string",
"pending-restart-in": 0
}
string
serverState
Optional
serverState
object
health-status
Optional
health-status
string
instance-id
Optional
instance-id
string
local-configuration-descriptor
Optional
local-configuration-descriptor
integer As int64
As int64
pending-restart-in
Optional
pending-restart-in
401
User is not authorized.
Returns
NodeStatusInfo
of type(s)
application/json
"NodeStatusInfo Object"
string
serverState
Optional
serverState
object
health-status
Optional
health-status
string
instance-id
Optional
instance-id
string
local-configuration-descriptor
Optional
local-configuration-descriptor
integer As int64
As int64
pending-restart-in
Optional
pending-restart-in
503
Server not in RUNNING state or unhealthy.
Returns
NodeStatusInfo
of type(s)
application/json
"NodeStatusInfo Object"
string
serverState
Optional
serverState
object
health-status
Optional
health-status
string
instance-id
Optional
instance-id
string
local-configuration-descriptor
Optional
local-configuration-descriptor
integer As int64
As int64
pending-restart-in
Optional
pending-restart-in
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/vco/api/health/readiness
Service Descriptor Service Operations
GET
Supported Api Versions
GET
Get Xml Schema
GET
Get Xml Schema 1
GET
Health Status
GET
Health Status Readiness
GET
Health Status Liveness
GET
Docs
GET
About Info
GET
Enumerate Services 1