Health Status

Health Status

A REST endpoint for retrieving server health status calculated on its health components (DB, authentication and etc.).

Request
URI
GET
https://{api_host}/vco/api/healthstatus
COPY
Query Parameters
boolean
showDetails
Optional
Constraints: default: false

showDetails

boolean
startupProbe
Optional
Constraints: default: false

startupProbe

boolean
showConfigurationDetails
Optional
Constraints: default: false

showConfigurationDetails

Authentication
This operation uses the following authentication methods.
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


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/vco/api/healthstatus
On This Page
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