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
Required
Responses
200

The request is successful.

Returns node-status of type(s) application/json 
{
    "health-status": {
        "description": "string",
        "state": "string",
        "time": 0,
        "childs": [
            {
                "name": "string",
                "description": "string",
                "isCritical": false,
                "state": "string",
                "message": "string"
            }
        ]
    },
    "instance-id": "string",
    "state": "string"
}
health-status
health-status
Optional

health-status

string
instance-id
Optional

instance-id

string
state
Optional

state


401

User is not authorized.

Operation doesn't return any data structure

On This Page
Service Descriptor Service Operations
GET
About Info
GET
Docs
GET
Enumerate Services
GET
Get Xml Schema
GET
Get Xml Schema
GET
Health Status
GET
Status
GET
Supported Api Versions