Enterprise Proxy Get Enterprise Proxy Gateway Pools

Enterprise Proxy Get Enterprise Proxy Gateway Pools

Gets all gateway pools associated with the specified enterprise proxy. Optionally includes all gateways or enterprises belonging to each pool.

Privileges required:

READ GATEWAY, or

CREATE ENTERPRISE

Request
URI
POST
https://{api_host}/portal/rest/enterpriseProxy/getEnterpriseProxyGatewayPools
COPY
Request Body
{
    "id": 0,
    "enterpriseProxyId": 0,
    "with": [
        "string"
    ]
}
integer
id
Optional

id

integer
enterpriseProxyId
Optional

enterpriseProxyId

array of string
with
Optional

with

Possible values are : gateways, enterprises,
Responses
200

Request was successfully processed

[
    {
        "id": 0,
        "networkId": 0,
        "enterpriseProxyId": 0,
        "created": "string",
        "name": "string",
        "description": "string",
        "isDefault": false,
        "handOffType": "string",
        "modified": "string",
        "enterprises": [
            {
                "id": 0,
                "created": "string",
                "networkId": 0,
                "gatewayPoolId": 0,
                "alertsEnabled": 0,
                "operatorAlertsEnabled": 0,
                "endpointPkiMode": "string",
                "name": "string",
                "domain": "string",
                "prefix": "string",
                "logicalId": "string",
                "accountNumber": "string",
                "description": "string",
                "contactName": "string",
                "contactPhone": "string",
                "contactMobile": "string",
                "contactEmail": "string",
                "streetAddress": "string",
                "streetAddress2": "string",
                "city": "string",
                "state": "string",
                "postalCode": "string",
                "country": "string",
                "lat": "number",
                "lon": "number",
                "timezone": "string",
                "locale": "string",
                "modified": "string"
            }
        ],
        "gateways": [
            {
                "gatewayPoolAssocId": 0,
                "poolName": "string",
                "id": 0,
                "created": "string",
                "networkId": 0,
                "enterpriseProxyId": 0,
                "siteId": 0,
                "activationKey": "string",
                "activationState": "string",
                "activationTime": "string",
                "softwareVersion": "string",
                "buildNumber": "string",
                "utilization": "number",
                "utilizationDetail": {
                    "load": "number",
                    "overall": "number",
                    "cpu": "number",
                    "memory": "number"
                },
                "connectedEdges": 0,
                "connectedEdgeList": [
                    {
                        "vceid": "string"
                    }
                ],
                "deviceId": "string",
                "logicalId": "string",
                "name": "string",
                "gatewayState": "string",
                "description": "string",
                "dnsName": "string",
                "isLoadBalanced": 0,
                "privateIpAddress": "string",
                "ipAddress": "string",
                "lastContact": "string",
                "systemUpSince": "string",
                "serviceUpSince": "string",
                "serviceState": "string",
                "endpointPkiMode": "string",
                "handOffDetail": {
                    "type": "string",
                    "subnets": [
                        {
                            "name": "string",
                            "routeCost": 0,
                            "cidrIp": "string",
                            "cidrPrefix": 0,
                            "encrypt": false,
                            "handOffType": "string"
                        }
                    ],
                    "icmpProbe": {
                        "enabled": false,
                        "probeType": "string",
                        "cTag": 0,
                        "sTag": 0,
                        "destinationIp": "string",
                        "frequencySeconds": 0,
                        "threshold": 0
                    },
                    "icmpResponder": {
                        "enabled": false,
                        "ipAddress": "string",
                        "mode": "string"
                    }
                },
                "ipsecGatewayDetail": {
                    "enabled": false,
                    "strictHostCheck": false,
                    "strictHostCheckDN": "string"
                },
                "modified": "string"
            }
        ]
    }
]
array of enterprise_proxy_get_enterprise_proxy_gateway_pools_result_item
Optional

400
Returns generic_400 of type(s) application/json
Operation doesn't return any data structure

500
Returns generic_500 of type(s) application/json
Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/portal/rest/enterpriseProxy/getEnterpriseProxyGatewayPools
On This Page
All Operations
POST
Enterprise Proxy Get Enterprise Proxy Cloneable Enterprises
POST
Enterprise Proxy Get Enterprise Proxy Edge Inventory
POST
Enterprise Proxy Get Enterprise Proxy Enterprises
POST
Enterprise Proxy Get Enterprise Proxy Gateway Pools
POST
Enterprise Proxy Get Enterprise Proxy Operator Profiles