Monitoring Get Enterprise Edge Link Status

Monitoring Get Enterprise Edge Link Status

Gets the current Edge and Edge-link status for all enterprises. edges.

Privileges required:

READ ENTERPRISE

READ EDGE

Request
URI
POST
https://{api_host}/portal/rest/monitoring/getEnterpriseEdgeLinkStatus
COPY
Request Body
{
    "enterprises": [
        0
    ],
    "enterpriseProxyId": 0,
    "networkId": 0,
    "links": false,
    "detailed": false
}
array of integer
enterprises
Optional

enterprises

integer
enterpriseProxyId
Optional

enterpriseProxyId

integer
networkId
Optional

networkId

boolean
links
Optional
Constraints: default: true

links

boolean
detailed
Optional

detailed

Responses
200

Request was successfully processed

Returns Array of monitoring_get_enterprise_edge_link_status_result_item of type(s) application/json
[
    {
        "displayName": "string",
        "edgeHASerialNumber": "string",
        "edgeId": 0,
        "edgeLastContact": "string",
        "edgeLatitude": "number",
        "edgeLongitude": "number",
        "edgeModelNumber": "string",
        "edgeName": "string",
        "edgeSerialNumber": "string",
        "edgeServiceUpSince": "string",
        "edgeState": "string",
        "edgeSystemUpSince": "string",
        "enterpriseId": 0,
        "enterpriseName": "string",
        "enterpriseProxyId": 0,
        "enterpriseProxyName": "string",
        "interface": "string",
        "internalId": "string",
        "isp": "string",
        "linkId": 0,
        "linkIpAddress": "string",
        "linkIpV6Address": "string",
        "linkLastActive": "string",
        "linkState": "string",
        "linkMode": "string",
        "linkBackupState": "string",
        "linkVpnState": "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/monitoring/getEnterpriseEdgeLinkStatus