Enterprise Proxy Get Enterprise Proxy Enterprises

Enterprise Proxy Get Enterprise Proxy Enterprises

Gets all partner enterprises. Optionally includes all Edges or Edge counts.

Privileges required:

READ ENTERPRISE

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

enterpriseProxyId

array of string
with
Optional

with

Possible values are : edges, edgeCount,
Responses
200

Request was successfully processed

[
    {
        "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",
        "edgeCount": 0,
        "edges": [
            {
                "id": 0,
                "created": "string",
                "name": "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",
                "shippingSameAsLocation": 0,
                "shippingContactName": "string",
                "shippingAddress": "string",
                "shippingAddress2": "string",
                "shippingCity": "string",
                "shippingState": "string",
                "shippingCountry": "string",
                "shippingPostalCode": "string",
                "modified": "string",
                "gatewayPoolId": 0,
                "networkId": 0,
                "returnData": false,
                "user": {
                    "email": "string",
                    "password": "string",
                    "password2": "string",
                    "username": "string"
                }
            }
        ]
    }
]
array of enterprise_proxy_get_enterprise_proxy_enterprises_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/getEnterpriseProxyEnterprises
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