Get Tunnel Service Healthcheck

Get health status for Secure Access Service by logicalId

Request

URI

GET

https://{api_host}/api/ztnad/v1/enterprises/{enterpriseLogicalId}/healthcheck/{logicalId}

COPY

Path Parameters

string

enterpriseLogicalId

Required

Enterprise Logical ID

string

logicalId

Required

Secure Access Service Logical ID

Responses

200

Secure Access Service

Returns getTunnelServiceHealthcheckResponse of type(s) application/json

{
    "_href": "/enterprises/1/healthcheck/1",
    "healthStatus": {
        "name": "text",
        "logicalId": "ac611099-9872-4b29-bd87-8c2ba8b62c82",
        "isServiceReachable": false,
        "popStatuses": [
            {
                "popName": "text",
                "popLogicalId": "ac611099-9872-4b29-bd87-8c2ba8b62c82",
                "isTunnelServiceHealthy": false
            }
        ]
    }
}

string

_href

Required

_href

object

healthStatus

Optional

healthStatus

400

Invalid Input

Returns httpResponseError of type(s) application/json

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

string

code

Required

code

Possible values are : INTERNAL_ERROR, INVALID_PARAMS, INVALID_QUERY_PARAMS, INVALID_CONFIG, HEALTHCHECK_UNAVAILABLE,

array of object

errors

Required

errors

404

Secure Access Service not found

Returns httpResponseError of type(s) application/json

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

string

code

Required

code

Possible values are : INTERNAL_ERROR, INVALID_PARAMS, INVALID_QUERY_PARAMS, INVALID_CONFIG, HEALTHCHECK_UNAVAILABLE,

array of object

errors

Required

errors

500

Internal Server Error

Returns httpResponseError of type(s) application/json

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

string

code

Required

code

Possible values are : INTERNAL_ERROR, INVALID_PARAMS, INVALID_QUERY_PARAMS, INVALID_CONFIG, HEALTHCHECK_UNAVAILABLE,

array of object

errors

Required

errors

On This Page

Description

Request