Enterprise Proxy Get Enterprise Proxy

Gets data for the specified enterprise proxy.

Privileges required:

READ PROXY

Request

URI

POST

https://{api_host}/portal/rest/enterpriseProxy/getEnterpriseProxy

COPY

Request Body

{
    "id": 0,
    "enterpriseProxyId": 0,
    "with": [
        "string"
    ]
}

integer

Optional

integer

enterpriseProxyId

Optional

enterpriseProxyId

array of string

with

Optional

with

Possible values are : gatewayPools, gatewayPoolIds,

Responses

200

Request was successfully processed

Returns enterprise_enterprise_proxy of type(s) application/json

This response body class contains all of the following: Inlineenterprise_enterprise_proxy0

{
    "id": 0,
    "created": "string",
    "networkId": 0,
    "proxyType": "string",
    "operateGateways": false,
    "logicalId": "string",
    "name": "string",
    "domain": "string",
    "prefix": "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",
    "modified": "string"
}

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/getEnterpriseProxy

On This Page

Description

Request

Request Body

Response

200 Response Body

Errors

Enterprise Proxy Operations

POST

Enterprise Proxy Get Enterprise Proxy

POST

Enterprise Proxy Get Enterprise Proxy Gateways