Healthcheck

• Health Check

health check

Request

URI

GET

https://{api_host}/api/cws/v1/healthcheck

COPY

Responses

200

Hide Details

Health check successful

Returns healthCheckResponse of type(s) application/json

{
    "status": "string",
    "version": "string",
    "description": "health check of cws-service",
    "checks": {
        "vni:responseTime": {
            "status": "string",
            "observedValue": "number",
            "observedUnit": "string",
            "time": "2020-07-18T15:48:18.000Z"
        },
        "gdmanage:responseTime": {
            "status": "string",
            "observedValue": "number",
            "observedUnit": "string",
            "time": "2020-07-18T15:48:18.000Z"
        },
        "database:connection": {
            "status": "string",
            "observedValue": "number",
            "observedUnit": "string",
            "time": "2020-07-18T15:48:18.000Z"
        },
        "database:responseTime": {
            "status": "string",
            "observedValue": "number",
            "observedUnit": "string",
            "time": "2020-07-18T15:48:18.000Z"
        },
        "cwsManager:responseTime": {
            "status": "string",
            "observedValue": "number",
            "observedUnit": "string",
            "time": "2020-07-18T15:48:18.000Z"
        },
        "policyManager:responseTime": {
            "status": "string",
            "observedValue": "number",
            "observedUnit": "string",
            "time": "2020-07-18T15:48:18.000Z"
        }
    }
}

string

status

Optional

status

Possible values are : pass, fail,

string

version

Optional

version

string

description

Optional

description

object

checks

Optional

checks

400

Hide Details

Invalid Input

Returns httpResponseError of type(s) application/json

{
    "code": "error code",
    "errors": [
        {
            "message": "error message",
            "path": "object.path"
        }
    ]
}

string

code

Required

code

Possible values are : INTERNAL_ERROR, INVALID_PARAMS, INVALID_QUERY_PARAMS, INVALID_LICENSE,

array of object

errors

Required

errors

500

Hide Details

Internal Server Error

Returns healthCheckResponse of type(s) application/json

{
    "status": "string",
    "version": "string",
    "description": "health check of cws-service",
    "checks": {
        "vni:responseTime": {
            "status": "string",
            "observedValue": "number",
            "observedUnit": "string",
            "time": "2020-07-18T15:48:18.000Z"
        },
        "gdmanage:responseTime": {
            "status": "string",
            "observedValue": "number",
            "observedUnit": "string",
            "time": "2020-07-18T15:48:18.000Z"
        },
        "database:connection": {
            "status": "string",
            "observedValue": "number",
            "observedUnit": "string",
            "time": "2020-07-18T15:48:18.000Z"
        },
        "database:responseTime": {
            "status": "string",
            "observedValue": "number",
            "observedUnit": "string",
            "time": "2020-07-18T15:48:18.000Z"
        },
        "cwsManager:responseTime": {
            "status": "string",
            "observedValue": "number",
            "observedUnit": "string",
            "time": "2020-07-18T15:48:18.000Z"
        },
        "policyManager:responseTime": {
            "status": "string",
            "observedValue": "number",
            "observedUnit": "string",
            "time": "2020-07-18T15:48:18.000Z"
        }
    }
}

string

status

Optional

status

Possible values are : pass, fail,

string

version

Optional

version

string

description

Optional

description

object

checks

Optional

checks

On This Page

Description

Request

Response

200 Response Body

Errors

Health Check Operations

GET

Healthcheck