Get Pops | Secure Access REST API

Get Pops

Get Pop List

Request

URI

GET

https://{api_host}/api/ztnad/v1/enterprises/{enterpriseLogicalId}/pops

COPY

Path Parameters

string

enterpriseLogicalId

Required

Enterprise Logical ID

Responses

200

Pop List

Returns getPopsResponse of type(s) application/json

{
    "_href": "/enterprises/1/ras/getPops",
    "popList": [
        {
            "name": "text",
            "logicalId": "ac611099-9872-4b29-bd87-8c2ba8b62c82",
            "gatewaysList": [
                {
                    "vcoLogicalId": "ac611099-9872-4b29-bd87-8c2ba8b62c82",
                    "vcoGatewayLogicalId": "ac611099-9872-4b29-bd87-8c2ba8b62c82",
                    "ipAddress": "192.168.2.1",
                    "endpointIpAddress": "192.168.2.1",
                    "name": "text"
                }
            ]
        }
    ]
}

string

_href

Required

_href

array of object

popList

Optional

popList

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

Pop List not found for enterprise

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